├── .gitignore ├── screenshots ├── backlinks.png └── unlinked-references.png ├── .github ├── workflows │ └── test.yml └── FUNDING.yml ├── Makefile ├── tests └── nroam-test.el ├── nroam-utils.el ├── readme.org ├── nroam-unlinked.el ├── nroam.el ├── nroam-backlinks.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *~ 3 | nroam-autoloads.el 4 | /makel.mk 5 | -------------------------------------------------------------------------------- /screenshots/backlinks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NicolasPetton/nroam/HEAD/screenshots/backlinks.png -------------------------------------------------------------------------------- /screenshots/unlinked-references.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NicolasPetton/nroam/HEAD/screenshots/unlinked-references.png -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | pull_request: 5 | push: 6 | 7 | jobs: 8 | test: 9 | runs-on: ubuntu-latest 10 | strategy: 11 | matrix: 12 | emacs_version: 13 | - 27.1 14 | - 26.3 15 | - 26.2 16 | - 26.1 17 | steps: 18 | - name: Set up Emacs 19 | uses: purcell/setup-emacs@master 20 | with: 21 | version: ${{matrix.emacs_version}} 22 | 23 | - name: Check out the source code 24 | uses: actions/checkout@v2 25 | 26 | - name: Test the project 27 | run: | 28 | make ci-dependencies 29 | emacs --version 30 | make check 31 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: NicolasPetton # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Dependencies to install. The project depends on a version of org 2 | # that is more recent than the one provided by Emacs 27.1. Because 3 | # makel will refuse to install org because it is built into Emacs, we 4 | # force a newer version by asking org-plus-contrib instead. 5 | ELPA_DEPENDENCIES=package-lint org-plus-contrib org-roam buttercup f s 6 | 7 | ELPA_ARCHIVES=melpa org gnu 8 | 9 | TEST_BUTTERCUP_OPTIONS=tests 10 | LINT_CHECKDOC_FILES=$(wildcard *.el) 11 | LINT_PACKAGE_LINT_FILES=nroam.el 12 | LINT_COMPILE_FILES=$(wildcard *.el) 13 | 14 | makel.mk: 15 | # Download makel 16 | @if [ -f ../makel/makel.mk ]; then \ 17 | ln -s ../makel/makel.mk .; \ 18 | else \ 19 | curl \ 20 | --fail --silent --show-error --insecure --location \ 21 | --retry 9 --retry-delay 9 \ 22 | -O https://gitlab.petton.fr/DamienCassou/makel/raw/v0.6.0/makel.mk; \ 23 | fi 24 | 25 | # Include makel.mk if present 26 | -include makel.mk 27 | -------------------------------------------------------------------------------- /tests/nroam-test.el: -------------------------------------------------------------------------------- 1 | ;;; nroam-test.el --- Tests for nroam -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2021 Damien Cassou 4 | 5 | ;; Author: Damien Cassou 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; Tests for nroam. 23 | 24 | ;;; Code: 25 | 26 | (require 'buttercup) 27 | (require 'nroam) 28 | 29 | (defmacro nroam-test-with-temp-file-buffer (&rest body) 30 | "Execute BODY within a temporary buffer backed by a temporary file. 31 | Execute BODY and cleanup the file and buffer after that." 32 | (declare (debug t)) 33 | (let ((filename-var (make-symbol "filename"))) 34 | `(let ((,filename-var (make-temp-file "nroam-test-"))) 35 | (unwind-protect 36 | (with-current-buffer (find-file ,filename-var) 37 | ,@body) 38 | (delete-file ,filename-var))))) 39 | 40 | (nroam-test-with-temp-file-buffer (insert "foo")) 41 | 42 | (defconst nroam-test-main-section-regexp "^* Backlinks") 43 | 44 | (describe "nroam" 45 | (describe "nroam-mode" 46 | (it "creates nroam sections immediately" 47 | (nroam-test-with-temp-file-buffer 48 | (insert "#+title: my notes\n") 49 | (nroam-mode) 50 | (setf (point) (point-min)) 51 | (let ((section-position (re-search-forward nroam-test-main-section-regexp nil t))) 52 | (expect section-position :not :to-be nil) 53 | (expect section-position :to-be-greater-than 10))))) 54 | (describe "nroam-goto" 55 | (it "moves point if nroam heading is present" 56 | (nroam-test-with-temp-file-buffer 57 | (insert "nroam is great\n") 58 | (nroam-update) 59 | (setf (point) (point-min)) 60 | (nroam-goto) 61 | (expect (looking-at-p nroam-test-main-section-regexp) :to-be t))))) 62 | 63 | (provide 'nroam-test) 64 | ;;; nroam-test.el ends here 65 | -------------------------------------------------------------------------------- /nroam-utils.el: -------------------------------------------------------------------------------- 1 | ;;; nroam-utils.el --- Util functions for nroam -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2021 Nicolas Petton 4 | 5 | ;; Author: Nicolas Petton 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; This library provides utility functions used by other files in nroam. 23 | 24 | ;;; Code: 25 | (require 'seq) 26 | (require 'org-roam) 27 | 28 | (defun nroam--pluralize (n thing) 29 | "Pluralize the string THING if N>1." 30 | (format "%s%s" thing (if (> n 1) "s" ""))) 31 | 32 | (defun nroam--ensure-empty-line () 33 | "Insert a newline character if the buffer does not contain one before point." 34 | (let ((inhibit-read-only t)) 35 | (unless (eq ?\n (char-before (1- (point)))) (insert "\n")))) 36 | 37 | (defun nroam--insert-heading (level title &optional tags) 38 | "Insert TITLE as a section heading with LEVEL stars. 39 | When non-nil, add the string or list of strings as TAGS to the heading." 40 | (let ((pos (point)) 41 | (stars (make-string level ?*))) 42 | (insert stars " " title "\n") 43 | (when tags 44 | (save-excursion 45 | (goto-char pos) 46 | (org-set-tags tags))))) 47 | 48 | (defun nroam--do-separated-by-newlines (function sequence) 49 | "Apply FUNCTION to each element of SEQUENCE. 50 | Insert a single newline between each call to FUNCTION." 51 | (seq-do-indexed (lambda (item index) 52 | (unless (= index 0) 53 | (delete-blank-lines) 54 | (nroam--ensure-empty-line)) 55 | (funcall function item)) 56 | sequence)) 57 | 58 | (defun nroam--fix-links (content origin) 59 | "Correct all relative links in CONTENT from ORIGIN. 60 | Temporary fix until `org-roam' v2 is out." 61 | (org-roam-buffer-expand-links content origin)) 62 | 63 | (provide 'nroam-utils) 64 | ;;; nroam-utils.el ends here 65 | -------------------------------------------------------------------------------- /readme.org: -------------------------------------------------------------------------------- 1 | * nroam [[https://github.com/NicolasPetton/nroam/actions/workflows/test.yml/badge.svg]] 2 | 3 | *Update*: With the release of [[https://blog.jethro.dev/posts/org_roam_v2/][org-roam v2]] and its new revamped side-buffer, I do not feel the same need for nroam as I did with org-roam v1. The project is now archived, but if someone wants to port nroam to org-roam v2, I'd be willing to hand over maintenance of the project. 4 | 5 | --- 6 | 7 | nroam is a supplementary package for [[https://github.com/org-roam/org-roam][org-roam]] that replaces the 8 | backlink side buffer of Org-roam. Instead, it displays org-roam 9 | backlinks at the end of org-roam buffers. The user can also click a 10 | button to see unlinked occurrences of the buffer title (as defined by 11 | =org-roam-unlinked-references=). 12 | 13 | ** Screenshots 14 | 15 | *** Backlinks 16 | [[file:screenshots/backlinks.png][file:screenshots/backlinks.png]] 17 | 18 | *** Unlinked references 19 | [[file:screenshots/unlinked-references.png][file:screenshots/unlinked-references.png]] 20 | 21 | * Rationale 22 | 23 | One of the ideas behind nroam is to remove the friction and effort it 24 | takes to consult backlinks. I consider backlinks to be a very central 25 | piece of information about a note. Backlinks can even be the most 26 | important content of a note, for instance when using page links as 27 | tags. 28 | 29 | It is easy to miss backlinks when they are not always visible with the 30 | main content of a note. The side buffer will not always be open, and 31 | even if it is, the information it contains is visually far away from 32 | the note you're looking at. 33 | 34 | By making them an integral part of the org buffer, backlinks also 35 | become more powerful. You could for instance make a sparse tree—see 36 | =org-sparse-tree= — to filter the contents of a note and its backlinks 37 | at the same time. 38 | 39 | * Installation 40 | 41 | nroam is not yet available in [[https://melpa.org][MELPA]]. Until it is, you can install the Elisp files by hand in your =.emacs.d= or if you use =straight.el= add the following to you init file. 42 | 43 | #+begin_src elisp 44 | (use-package nroam 45 | :straight '(nroam :host github 46 | :branch "master" 47 | :repo "NicolasPetton/nroam") 48 | :after org-roam 49 | :config 50 | (add-hook 'org-mode-hook #'nroam-setup-maybe)) 51 | #+end_src 52 | 53 | 54 | * Setup & usage 55 | 56 | To setup nroam for all =org-mode= buffer, evaluate the following: 57 | 58 | #+begin_src elisp 59 | (add-hook 'org-mode-hook #'nroam-setup-maybe) 60 | #+end_src 61 | 62 | The linked references section will be updated after each buffer save. 63 | It can also be manually updated by typing =C-c C-c= anywhere in the 64 | linked references section. 65 | 66 | * Warning 67 | 68 | This package is in its infancy. Be careful when using it as it 69 | modifies your =org-mode= buffers—it should not modify your files 70 | though. Backup your data often. 71 | -------------------------------------------------------------------------------- /nroam-unlinked.el: -------------------------------------------------------------------------------- 1 | ;;; nroam-unlinked.el --- Unlinked references section for nroam.el -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2021 Nicolas Petton 4 | 5 | ;; Author: Nicolas Petton 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; This library provides an unlinked references nroam section for org-roam 23 | ;; buffers. 24 | 25 | ;;; Code: 26 | (require 'org-roam) 27 | (require 'nroam-utils) 28 | (declare-function nroam-register-section "nroam.el") 29 | (declare-function nroam-update "nroam.el") 30 | 31 | (defvar-local nroam-unlinked-show-references nil 32 | "When non-nil, show unlinked references for the current buffer.") 33 | 34 | (defun nroam-unlinked-register-section () 35 | "Register `nroam-unlinked-section' as a section in nroam." 36 | (nroam-register-section #'nroam-unlinked-section)) 37 | 38 | (defun nroam-unlinked-section () 39 | "Insert `org-roam' unlinked references for the current buffer." 40 | (nroam-unlinked--insert-heading) 41 | (if nroam-unlinked-show-references 42 | (nroam-unlinked--insert-references) 43 | (nroam-unlinked--insert-toggle-button))) 44 | 45 | (defun nroam-unlinked--insert-heading () 46 | "Insert the heading for unlinked references." 47 | (nroam--insert-heading 2 "Unlinked references")) 48 | 49 | (defun nroam-unlinked--insert-references () 50 | "Insert unlinked references for the current buffer." 51 | (let (content) 52 | (save-window-excursion 53 | (org-roam-unlinked-references) 54 | (let ((buf (current-buffer))) 55 | (goto-char (point-min)) 56 | (search-forward "* Unlinked References\n" nil t) 57 | (setq content (buffer-substring (point) (point-max))) 58 | (kill-buffer buf))) 59 | (insert content))) 60 | 61 | (defun nroam-unlinked--insert-toggle-button () 62 | "Insert a button to show unlinked references." 63 | (let ((beg (point))) 64 | (insert "[Show unlinked references]") 65 | (make-text-button beg (point) 'action #'nroam-unlinked--show-references))) 66 | 67 | (defun nroam-unlinked--show-references (&rest _) 68 | "Search for and show unlinked references." 69 | (let ((inhibit-read-only t) 70 | (pos (point-at-bol))) 71 | (setq nroam-unlinked-show-references t) 72 | (nroam-update) 73 | (goto-char pos) 74 | (org-back-to-heading))) 75 | 76 | (provide 'nroam-unlinked) 77 | ;;; nroam-unlinked.el ends here 78 | -------------------------------------------------------------------------------- /nroam.el: -------------------------------------------------------------------------------- 1 | ;;; nroam.el --- Org-roam backlinks within org-mode buffers -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2021 Nicolas Petton 4 | 5 | ;; Author: Nicolas Petton 6 | ;; URL: https://github.com/NicolasPetton/nroam 7 | ;; Keywords: outlines, convenience 8 | ;; Version: 0.9.0 9 | ;; Package-Requires: ((emacs "26.1") (org-roam "1.2.3") (org "9.4.4")) 10 | 11 | ;; This file is NOT part of GNU Emacs. 12 | 13 | ;; This program is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | ;;; Commentary: 27 | 28 | ;; nroam is a supplementary package for org-roam that replaces the backlink side 29 | ;; buffer of Org-roam. Instead, it displays org-roam backlinks at the end of 30 | ;; org-roam buffers. 31 | ;; 32 | ;; To setup nroam for all org-roam buffers, evaluate the following: 33 | ;; (add-hook 'org-mode-hook #'nroam-setup-maybe) 34 | 35 | ;;; Code: 36 | 37 | (require 'org-element) 38 | (require 'org-capture) 39 | (require 'seq) 40 | (require 'subr-x) 41 | (require 'bookmark) 42 | 43 | (require 'nroam-utils) 44 | (require 'nroam-backlinks) 45 | (require 'nroam-unlinked) 46 | 47 | (defvar nroam--sections nil 48 | "List of functions to be called to insert sections in nroam buffers.") 49 | 50 | (defvar nroam--sections-map 51 | (let ((map (make-sparse-keymap))) 52 | (define-key map (kbd "C-c C-c") #'nroam-update) 53 | (define-key map (kbd "RET") #'nroam-return) 54 | map) 55 | "Local keymap within nroam sections.") 56 | 57 | (defun nroam-register-section (function) 58 | "Add FUNCTION as a section in nroam." 59 | (add-to-list 'nroam--sections function t)) 60 | 61 | (defvar-local nroam-start-marker nil) 62 | (defvar-local nroam-end-marker nil) 63 | 64 | (defmacro with-nroam-markers (&rest body) 65 | "Evaluate BODY. 66 | Make the region inserted by BODY read-only, and marked with 67 | `nroam-start-marker' and `nroam-end-marker'." 68 | (declare (indent 0) (debug t)) 69 | `(let ((beg (point))) 70 | (set-marker nroam-start-marker (point)) 71 | ,@body 72 | (let* ((end (point)) 73 | (ov (make-overlay beg end))) 74 | (overlay-put ov 'keymap nroam--sections-map) 75 | (put-text-property beg (1+ beg) 'front-sticky '(read-only)) 76 | (put-text-property beg end 'read-only t) 77 | ;; Add a non-read-only newline so that text can be inserted at the end of 78 | ;; the buffer. 79 | (insert "\n")) 80 | (set-marker nroam-end-marker (point)))) 81 | 82 | ;;;###autoload 83 | (defun nroam-setup-maybe () 84 | "Setup nroam for the current buffer iff an `org-roam' buffer." 85 | (when (nroam--org-roam-file-p) 86 | (nroam-mode))) 87 | 88 | ;;;###autoload 89 | (define-minor-mode nroam-mode 90 | "Show nroam sections at the end of org-roam buffers." 91 | :lighter " nroam" 92 | (if nroam-mode 93 | (progn 94 | (add-hook 'before-save-hook #'nroam--prune nil t) 95 | (add-hook 'after-save-hook #'nroam--update-maybe nil t) 96 | (nroam--maybe-insert-immediately)) 97 | (remove-hook 'before-save-hook #'nroam--prune t) 98 | (remove-hook 'after-save-hook #'nroam--update-maybe t) 99 | (nroam--prune))) 100 | 101 | (defun nroam--maybe-insert-immediately () 102 | "Insert nroam sections iff the buffer file exists." 103 | (when (file-exists-p buffer-file-name) 104 | (nroam-update))) 105 | 106 | ;;;###autoload 107 | (defun nroam-return () 108 | "Open nroam link or push button at point." 109 | (interactive) 110 | (if (get-text-property (point) 'button) 111 | (call-interactively #'push-button) 112 | (nroam--follow-link))) 113 | 114 | ;;;###autoload 115 | (defun nroam-update () 116 | "Update nroam sections for the current buffer." 117 | (interactive) 118 | (nroam--setup-markers) 119 | (nroam--prune) 120 | (nroam--insert)) 121 | 122 | (defun nroam--org-roam-file-p () 123 | "Return non-nil if the current buffer is an `org-roam' buffer." 124 | (org-roam--org-roam-file-p)) 125 | 126 | (defun nroam--update-maybe () 127 | "Update backlinks when nroam is enabled." 128 | (when nroam-mode 129 | (nroam-update))) 130 | 131 | (defun nroam--setup-markers () 132 | "Setup the current buffer with markers for nroam." 133 | (unless (nroam--sections-inserted-p) 134 | (progn 135 | (setq nroam-start-marker (make-marker)) 136 | (setq nroam-end-marker (make-marker))))) 137 | 138 | (defun nroam--sections-inserted-p () 139 | "Return non-nil if the current buffer has nroam sections inserted." 140 | (and (markerp nroam-start-marker) 141 | (marker-position nroam-start-marker))) 142 | 143 | (defun nroam-goto () 144 | "Move point to the beginning of nroam sections if any." 145 | (interactive) 146 | (when (nroam--sections-inserted-p) 147 | (setf (point) (marker-position nroam-start-marker)))) 148 | 149 | (defun nroam--prune () 150 | "Remove nroam sections from the current buffer." 151 | (let ((inhibit-read-only t)) 152 | (save-excursion 153 | (goto-char (point-min)) 154 | (with-buffer-modified-unmodified 155 | (when (nroam--sections-inserted-p) 156 | (delete-region nroam-start-marker nroam-end-marker)))))) 157 | 158 | (defun nroam--insert () 159 | "Insert nroam sections in the current buffer." 160 | (with-buffer-modified-unmodified 161 | (save-excursion 162 | (goto-char (point-max)) 163 | (unless (bobp) 164 | (nroam--ensure-empty-line)) 165 | (with-nroam-markers 166 | (nroam--insert-heading 1 "Backlinks" "noexport") 167 | (nroam--do-separated-by-newlines #'funcall nroam--sections)) 168 | (nroam--set-sections-visibility)))) 169 | 170 | (defun nroam--set-sections-visibility () 171 | "Set nroam section visibility according to `org-set-startup-visibility'." 172 | (when (nroam--sections-inserted-p) 173 | (save-restriction 174 | (narrow-to-region nroam-start-marker nroam-end-marker) 175 | (org-set-startup-visibility)))) 176 | 177 | (defun nroam--follow-link () 178 | "Follow backlink at point." 179 | (when (get-text-property (point) 'nroam-link) 180 | (let ((file (get-text-property (point) 'file)) 181 | (point (get-text-property (point) 'point))) 182 | (org-open-file file t) 183 | (goto-char point)))) 184 | 185 | (nroam-backlinks-register-section) 186 | (nroam-unlinked-register-section) 187 | 188 | (provide 'nroam) 189 | ;;; nroam.el ends here 190 | -------------------------------------------------------------------------------- /nroam-backlinks.el: -------------------------------------------------------------------------------- 1 | ;;; nroam-backlinks.el --- Backlink section for nroam.el -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2021 Nicolas Petton 4 | 5 | ;; Author: Nicolas Petton 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; This library provides a backlinks nroam section for org-roam buffers. 23 | 24 | ;;; Code: 25 | (require 'org) 26 | (require 'org-element) 27 | (require 'org-roam) 28 | (require 'seq) 29 | (require 'subr-x) 30 | (require 'org-element) 31 | (require 'nroam-utils) 32 | (declare-function nroam-register-section "nroam.el") 33 | 34 | (defvar nroam-backlinks--work-buffer-name " *nroam-work*") 35 | 36 | (defun nroam-backlinks-register-section () 37 | "Register `nroam-backlinks-section'." 38 | (nroam-register-section #'nroam-backlinks-section)) 39 | 40 | (defun nroam-backlinks-section () 41 | "Insert `org-roam' backlinks for the current buffer." 42 | (let* ((backlinks (nroam-backlinks--get-backlinks)) 43 | (groups (seq-reverse (nroam-backlinks--group backlinks)))) 44 | (nroam-backlinks--insert-heading (seq-length backlinks)) 45 | (nroam--do-separated-by-newlines #'nroam-backlinks--insert-group groups) 46 | (nroam-backlinks--hide-drawers))) 47 | 48 | (defun nroam-backlinks--get-backlinks () 49 | "Return a list of backlinks for the current buffer." 50 | (if-let* ((file-path (buffer-file-name (current-buffer))) 51 | (titles (org-roam--extract-titles))) 52 | (org-roam--get-backlinks (cons file-path titles)))) 53 | 54 | (defun nroam-backlinks--group (backlinks) 55 | "Return BACKLINKS grouped by source file." 56 | (seq-group-by #'car backlinks)) 57 | 58 | (defun nroam-backlinks--insert-heading (count) 59 | "Insert the heading for the backlinks section with a COUNT." 60 | (let ((title (format "%s %s" 61 | (if (= count 0) "No" count) 62 | (nroam--pluralize count "linked reference")))) 63 | (nroam--insert-heading 2 title))) 64 | 65 | (defun nroam-backlinks--insert-group (group) 66 | "Insert all backlinks in GROUP." 67 | (let* ((file (car group)) 68 | (backlinks (cdr group)) 69 | (title (org-roam-format-link file 70 | (org-roam-db--get-title file) 71 | "file"))) 72 | (nroam--insert-heading 3 title) 73 | (nroam--do-separated-by-newlines #'nroam-backlinks--insert-backlink backlinks))) 74 | 75 | (defun nroam-backlinks--insert-backlink (backlink) 76 | "Insert the source element where BACKLINK is defined." 77 | (seq-let (file _ props) backlink 78 | (when-let* ((point (plist-get props :point)) 79 | (elt (nroam-backlinks--crawl-source file point)) 80 | (type (plist-get elt :type)) 81 | (content (nroam--fix-links (string-trim (plist-get elt :string)) file)) 82 | (beg (point))) 83 | (let ((outline (plist-get elt :outline)) 84 | (full-outline (plist-get elt :full-outline))) 85 | (if (eq type 'headline) 86 | (nroam-backlinks--insert-backlink-subtree content outline) 87 | (nroam-backlinks--insert-backlink-content content full-outline))) 88 | (set-text-properties beg (point) 89 | `(nroam-link t file ,file point ,point)) 90 | (insert "\n")))) 91 | 92 | (defun nroam-backlinks--insert-backlink-subtree (content outline) 93 | "Insert CONTENT as a heading with its subtree. 94 | When OUTLINE is non-nil, insert it as a heading." 95 | (nroam-backlinks--insert-backlink-breadcrumbs outline) 96 | (nroam-backlinks--insert-subtree content (if outline 5 4))) 97 | 98 | (defun nroam-backlinks--insert-backlink-content (content outline) 99 | "Insert CONTENT with OUTLINE as a heading if non-nil." 100 | (nroam-backlinks--insert-backlink-breadcrumbs outline) 101 | (insert content)) 102 | 103 | (defun nroam-backlinks--insert-backlink-breadcrumbs (outline) 104 | "Insert OUTLINE if non-nil as a breadcrumbs heading." 105 | (when outline 106 | (let ((str-outline (concat "* " (string-join outline " › ")))) 107 | (nroam-backlinks--insert-subtree str-outline)))) 108 | 109 | (defun nroam-backlinks--insert-subtree (subtree &optional level) 110 | "Insert SUBTREE as a LEVEL headline. 111 | LEVEL defaults to 4 when nil." 112 | (org-paste-subtree (or level 4) subtree) 113 | (goto-char (point-max))) 114 | 115 | (defun nroam-backlinks--crawl-source (file point) 116 | "Return the source element in FILE at POINT." 117 | (with-current-buffer (nroam-backlinks--work-buffer) 118 | (insert-file-contents file nil nil nil 'replace) 119 | (goto-char point) 120 | (let* ((elt (org-element-at-point)) 121 | (begin (org-element-property :begin elt)) 122 | (end (org-element-property :end elt)) 123 | (type (org-element-type elt)) 124 | (outline (org-get-outline-path)) 125 | (full-outline (unless (org-before-first-heading-p) 126 | (org-get-outline-path 'with-self)))) 127 | `(:type ,type 128 | :string ,(buffer-substring begin end) 129 | :outline ,outline 130 | :full-outline ,full-outline)))) 131 | 132 | (defun nroam-backlinks--hide-drawers () 133 | "Fold all drawers starting at POINT in the current buffer." 134 | ;; Taken from `org-hide-drawer-all'. 135 | (save-excursion 136 | (while (re-search-forward org-drawer-regexp nil t) 137 | (let* ((pair (get-char-property-and-overlay (line-beginning-position) 138 | 'invisible)) 139 | (o (cdr-safe pair))) 140 | (if (overlayp o) (goto-char (overlay-end o)) ;invisible drawer 141 | (pcase (get-char-property-and-overlay (point) 'invisible) 142 | (`(outline . ,o) (goto-char (overlay-end o))) ;already folded 143 | (_ 144 | (let* ((drawer (org-element-at-point)) 145 | (type (org-element-type drawer))) 146 | (when (memq type '(drawer property-drawer)) 147 | (org-hide-drawer-toggle t nil drawer) 148 | ;; Make sure to skip drawer entirely or we might flag it 149 | ;; another time when matching its ending line with 150 | ;; `org-drawer-regexp'. 151 | (goto-char (org-element-property :end drawer))))))))))) 152 | 153 | (defun nroam-backlinks--work-buffer () 154 | "Return the hidden buffer used for crawling operations." 155 | (if-let ((buf (get-buffer nroam-backlinks--work-buffer-name))) 156 | buf 157 | (nroam-backlinks--init-work-buffer))) 158 | 159 | (defun nroam-backlinks--init-work-buffer () 160 | "Initiate nroam hidden buffer." 161 | (let ((buf (get-buffer-create nroam-backlinks--work-buffer-name))) 162 | (with-current-buffer buf 163 | (delay-mode-hooks (org-mode))) 164 | buf)) 165 | 166 | (provide 'nroam-backlinks) 167 | ;;; nroam-backlinks.el ends here 168 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------