├── .gitignore ├── media └── animation.gif ├── tests ├── run.py ├── tb_example_many.vhd └── vunit-mode-tests.el ├── Makefile ├── .github └── workflows │ └── github-actions-ci.yml ├── README.md ├── vunit-mode.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | .cask -------------------------------------------------------------------------------- /media/animation.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/embed-me/vunit-mode/HEAD/media/animation.gif -------------------------------------------------------------------------------- /tests/run.py: -------------------------------------------------------------------------------- 1 | # Example from https://vunit.github.io/user_guide.html 2 | 3 | from vunit import VUnit 4 | 5 | # Create VUnit instance by parsing command line arguments 6 | vu = VUnit.from_argv() 7 | 8 | # Create library 'lib' 9 | lib = vu.add_library("lib") 10 | 11 | # Add all files ending in .vhd in current working directory to library 12 | lib.add_source_files("*.vhd") 13 | 14 | # Run vunit function 15 | vu.main() 16 | -------------------------------------------------------------------------------- /tests/tb_example_many.vhd: -------------------------------------------------------------------------------- 1 | -- Example from https://vunit.github.io/user_guide.html 2 | 3 | library vunit_lib; 4 | context vunit_lib.vunit_context; 5 | 6 | entity tb_example_many is 7 | generic (runner_cfg : string); 8 | end entity; 9 | 10 | architecture tb of tb_example_many is 11 | begin 12 | main : process 13 | begin 14 | test_runner_setup(runner, runner_cfg); 15 | 16 | while test_suite loop 17 | 18 | if run("test_pass") then 19 | report "This will pass"; 20 | 21 | elsif run("test_fail") then 22 | assert false report "It fails"; 23 | 24 | end if; 25 | end loop; 26 | 27 | test_runner_cleanup(runner); 28 | end process; 29 | end architecture; 30 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all build tests clean 2 | 3 | TEST_DIR=tests 4 | 5 | EMACS=emacs 6 | EMACS_CLEAN=-Q 7 | EMACS_BATCH=$(EMACS_CLEAN) --batch 8 | EMACS_LOAD_DEPENDENCIES=(setq package-enable-at-startup nil) \ 9 | (defvar package-load-list '((lv t) \ 10 | (hydra t) \ 11 | (el-mock t))) \ 12 | (package-initialize) 13 | 14 | all : build tests 15 | 16 | build : 17 | $(EMACS) $(EMACS_BATCH) \ 18 | --eval "(progn \ 19 | $(EMACS_LOAD_DEPENDENCIES) \ 20 | (setq byte-compile-error-on-warn t) \ 21 | (batch-byte-compile))" *.el 22 | 23 | tests : 24 | @cd '$(TEST_DIR)' && \ 25 | (for test in *-tests.el; do \ 26 | $(EMACS) $(EMACS_BATCH) -L . -L .. \ 27 | --eval "(progn \ 28 | $(EMACS_LOAD_DEPENDENCIES))" \ 29 | -l cl \ 30 | -l "$$test" \ 31 | -f "ert-run-tests-batch-and-exit"; \ 32 | done) 33 | 34 | clean : 35 | @rm -f *.elc 36 | -------------------------------------------------------------------------------- /.github/workflows/github-actions-ci.yml: -------------------------------------------------------------------------------- 1 | name: check 2 | 3 | on: 4 | pull_request: 5 | push: 6 | paths-ignore: 7 | - 'media/**' 8 | 9 | jobs: 10 | check: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | fail-fast: false 14 | matrix: 15 | emacs_version: 16 | - 24.4 17 | - 24.5 18 | - 25.1 19 | - 25.2 20 | - 25.3 21 | - 26.1 22 | - 26.2 23 | - 26.3 24 | - 27.1 25 | - 27.2 26 | - 28.1 27 | - 28.2 28 | - 29.1 29 | - 29.2 30 | - 29.3 31 | - 29.4 32 | - 30.1 33 | - snapshot 34 | elisp-check: 35 | - melpa 36 | - load-file 37 | - byte-compile 38 | - checkdoc 39 | - package-lint 40 | include: 41 | - emacs_version: snapshot 42 | ignore_warnings: false 43 | steps: 44 | - uses: actions/checkout@v2 45 | - uses: purcell/setup-emacs@master 46 | with: 47 | version: ${{ matrix.emacs_version }} 48 | - uses: leotaku/elisp-check@master 49 | with: 50 | check: ${{ matrix.elisp-check }} 51 | file: vunit-mode.el 52 | 53 | -------------------------------------------------------------------------------- /tests/vunit-mode-tests.el: -------------------------------------------------------------------------------- 1 | ;;; vunit-mode.el --- VUnit Runner Interface -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2021 Lukas Lichtl 4 | 5 | ;; Author: Lukas Lichtl 6 | ;; URL: https://github.com/embed-me 7 | ;; Version: 1.0 8 | ;; Package-Requires: ((hydra "0.14.0")(emacs "24.3")) 9 | ;; Keywords: VUnit, Python, tools 10 | 11 | ;; This program is free software; you can redistribute it and/or 12 | ;; modify it under the terms of the GNU General Public License 13 | ;; as published by the Free Software Foundation; either version 3 14 | ;; of the License, or (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; Some basic tests for vunit-mode. 27 | 28 | ;;; Code: 29 | 30 | (require 'ert) 31 | (require 'ert-x) 32 | (require 'el-mock) 33 | (require 'vunit-mode) 34 | (require 'hydra) 35 | 36 | (ert-deftest vunit-flags-check () 37 | (should (equal vunit-flags '())) 38 | (vunit-toggle-flag "--gui") 39 | (should (equal vunit-flags '("--gui"))) 40 | (vunit-toggle-flag "--verbose") 41 | (should (equal vunit-flags '("--verbose" "--gui"))) 42 | (vunit-toggle-flag "--verbose") 43 | (should (equal vunit-flags '("--gui"))) 44 | (vunit-toggle-flag "--gui") 45 | (should (equal vunit-flags '()))) 46 | 47 | (ert-deftest vunit-sim-cursor-check () 48 | (should (with-mock 49 | (stub thing-at-point => "run (\"foo\")") 50 | (vunit--match-line))) 51 | (should (with-mock 52 | (stub thing-at-point => "run(\"foo\")") 53 | (vunit--match-line))) 54 | (should (equal 55 | (with-mock 56 | (stub thing-at-point => "runF (\"foo\")") 57 | (vunit--match-line)) 58 | nil)) 59 | (should (equal 60 | (with-mock 61 | (stub thing-at-point => "whatever (\"foo\")") 62 | (vunit--match-line)) 63 | nil)) 64 | (should (equal 65 | (with-mock 66 | (stub thing-at-point => "whatever some more") 67 | (vunit--match-line)) 68 | nil))) 69 | 70 | (ert-deftest vunit-auto-scroll-check () 71 | (custom-set-variables '(vunit-auto-scroll nil)) 72 | (should (equal compilation-scroll-output nil)) 73 | (custom-set-variables '(vunit-auto-scroll t)) 74 | (should (equal compilation-scroll-output t))) 75 | 76 | (provide 'vunit-mode-tests) 77 | 78 | ;;; vunit-mode-tests.el ends here 79 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VUnit Mode [![check][check-badge]][check-link] [![melpa badge][melpa-badge]][melpa-link] 2 | 3 | This is a package for GNU Emacs that can be used to interface with 4 | [VUnit](https://vunit.github.io/) which is an open-source testing 5 | framework for VHDL/SystemVerilog. 6 | 7 | It hooks to the VHDL mode and wraps the function calls to 8 | the run script used by VUnit, therefore allows verification of unit 9 | tests while writing code without ever leaving Emacs. 10 | At the moment, it is in a very early stage of development where it 11 | simply makes use of the compile package and hydra, but in the near 12 | future and with some support from the community, the idea is to 13 | implement something similar to Magit for VUnit. 14 | 15 | ![](media/animation.gif) 16 | 17 | ## Prerequisites 18 | 19 | The basic requirements are that the HDL simulator 20 | (eg. [Modelsim](https://eda.sw.siemens.com/en-US/ic/modelsim/)) 21 | is in the path and that VUnit is installed in the python environment. 22 | 23 | ## Installation 24 | 25 | ### MELPA 26 | 27 | The preferred installation method is through [MELPA](https://melpa.org/). 28 | 29 | Add MELPA in your `~/.emacs` or `~/.emacs.d/init.el` init file. 30 | 31 | ```elisp 32 | (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/")) 33 | ``` 34 | 35 | Then install the package 36 | 37 | ```elisp 38 | M-x package-refresh-contents RET 39 | M-x package-install RET vunit-mode RET 40 | ``` 41 | 42 | Finally enable the mode in your init file. 43 | 44 | ```elisp 45 | (require 'vunit-mode) 46 | (global-vunit-mode t) 47 | ``` 48 | 49 | ### Manual 50 | 51 | To manually install the package, clone this repository and add the 52 | following in your `~/.emacs` or `~/.emacs.d/init.el` init file. 53 | 54 | ```elisp 55 | (add-to-list 'load-path "/path-to-repository/") 56 | (require 'vunit-mode) 57 | (global-vunit-mode t) 58 | ``` 59 | 60 | ## Usage 61 | 62 | ### Keybinding 63 | 64 | The default keybinding to invoke vunit-mode is `C-x x`. 65 | 66 | Keys highlighted in blue will execute the specified action and 67 | quit the vunit-mode command window. 68 | The ones marked in red, however, will add additional flags 69 | to the actions available in blue. 70 | 71 | ### Menu Bar 72 | 73 | Once a VHDL file is loaded in the buffer, the `VUnit` Menu will 74 | appear in the Menu Bar. It is also possible to set flags and run 75 | tests without having to know any key bindings at all. 76 | 77 | ## Configuration 78 | 79 | As for now, it is possible to configure the following variables 80 | using `M-x Customize`: 81 | 82 | Path to the VUnit directory. 83 | > vunit-path 84 | 85 | The Python executable used by VUnit. 86 | > vunit-python-executable 87 | 88 | Name of the VUnit output directory. 89 | > vunit-run-outdir 90 | 91 | Name of the python script to run. 92 | > vunit-run-script 93 | 94 | Number of threads to use in parallel. 95 | > vunit-num-threads 96 | 97 | Auto-scroll to bottom in the compile buffer. 98 | > vunit-auto-scroll 99 | 100 | ## Contributing 101 | 102 | Since this is my first application ever written in Emacs Lisp 103 | support and input from advanced developers is highly appreciated. 104 | 105 | To report bugs and suggest new features please use the 106 | [issue tracker](https://github.com/embed-me/vunit-mode/issues). 107 | In order to merge some code, please open a 108 | [pull request](https://github.com/embed-me/vunit-mode/pulls). 109 | 110 | ## Acknowledgments 111 | 112 | The idea for a VUnit Emacs mode seemed to be around for a while and was 113 | already discussed online a couple of years ago, however, 114 | for me, Markus Pfaff from FH-Hagenberg was the one who inspired me to 115 | take the implementation into my own hands and despite my lack of knowledge 116 | in elisp publish the code written so far. 117 | 118 | 119 | [check-link]: https://github.com/embed-me/vunit-mode/actions 120 | [check-badge]: https://github.com/embed-me/vunit-mode/actions/workflows/github-actions-ci.yml/badge.svg 121 | [melpa-link]: https://melpa.org/#/vunit-mode 122 | [melpa-badge]: https://melpa.org/packages/vunit-mode-badge.svg -------------------------------------------------------------------------------- /vunit-mode.el: -------------------------------------------------------------------------------- 1 | ;;; vunit-mode.el --- VUnit Runner Interface -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2021 Lukas Lichtl 4 | 5 | ;; Author: Lukas Lichtl 6 | ;; URL: https://github.com/embed-me 7 | ;; Version: 1.0 8 | ;; Package-Requires: ((hydra "0.14.0")(emacs "24.3")) 9 | ;; Keywords: VUnit, Python, tools 10 | 11 | ;; This program is free software; you can redistribute it and/or 12 | ;; modify it under the terms of the GNU General Public License 13 | ;; as published by the Free Software Foundation; either version 3 14 | ;; of the License, or (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; A trivial global minor mode for VUnit which hooks to the 27 | ;; VHDL major mode and interfaces with a VUnit run script by 28 | ;; making use of the compile package inside Emacs. 29 | 30 | ;; The basic requirements are that the HDL simulator is in the 31 | ;; path and that VUnit is installed in the python environment. 32 | 33 | ;; Before compilation, the `vunit-path' must me specified. 34 | ;; This can either be done in the init file or the user will be 35 | ;; prompted for it. 36 | 37 | ;; Per default `vunit-run-script' assumes "run.py", but this 38 | ;; is also user configurable. For a full list of available 39 | ;; configurations run "M-x customize" and search for vunit. 40 | 41 | ;; Keys highlighted in blue will execute the specified action and 42 | ;; quit the vunit-mode command window. 43 | ;; The ones marked in red, however, will add additional flags 44 | ;; to the actions available in blue. 45 | 46 | ;; The default keybinding to invoke vunit-mode is "C-x x". 47 | 48 | ;;; Code: 49 | 50 | (require 'hydra) 51 | 52 | (defgroup vunit nil 53 | "VUnit HDL Interface for Emacs." 54 | :group 'tools 55 | :prefix "vunit-") 56 | 57 | ;;; user setable variables 58 | 59 | (defcustom vunit-extra-flags "--no-color" 60 | "Any extra flags to append to VUnit call string." 61 | :group 'vunit 62 | :type 'string) 63 | 64 | (defcustom vunit-python-executable (executable-find "python") 65 | "The Python executable used by VUnit." 66 | :group 'vunit 67 | :type 'string) 68 | 69 | (defcustom vunit-path nil 70 | "Specify the path to the VUnit directory." 71 | :group 'vunit 72 | :type 'string) 73 | 74 | (defcustom vunit-run-script "run.py" 75 | "Name of the python script to run." 76 | :group 'vunit 77 | :type 'string) 78 | 79 | (defcustom vunit-run-outdir "vunit_out" 80 | "Name of the VUnit output directory." 81 | :group 'vunit 82 | :type 'string) 83 | 84 | (defcustom vunit-num-threads 1 85 | "Number of threads to use in parallel." 86 | :group 'vunit 87 | :type 'integer) 88 | 89 | (defcustom vunit-simulator nil 90 | "Simulator to be used by VUnit process. 91 | If set to nil choose automatically the first available in the $PATH." 92 | :group 'vunit 93 | :type '(choice (const :tag "Automatic" nil) 94 | (const :tag "ActiveHDL" "activehdl") 95 | (const :tag "RivieraPro" "rivierapro") 96 | (const :tag "GHDL" "ghdl") 97 | (const :tag "ModelSim" "modelsim"))) 98 | 99 | ;; Create a "special" variable so that it is dynamically 100 | ;; bound (even if `lexical-binding' is t) 101 | (defvar compilation-scroll-output) 102 | (defcustom vunit-auto-scroll t 103 | "Auto-scroll to bottom in the compile buffer." 104 | :group 'vunit 105 | :type 'boolean 106 | :set #'(lambda (symbol value) 107 | (set-default symbol value) 108 | (setq compilation-scroll-output value))) 109 | 110 | ;;; internal variables 111 | 112 | (defconst vunit--flag-gui "--gui") 113 | (defconst vunit--flag-verbose "--verbose") 114 | (defconst vunit--flag-keep-compiling "--keep-compiling") 115 | (defconst vunit--flag-fail-fast "--fail-fast") 116 | (defconst vunit--flag-log-level "--log-level debug") 117 | 118 | (defvar vunit-mode-map 119 | (let ((map (make-sparse-keymap))) 120 | (define-key map (kbd "C-x x") #'vunit-buffer-menu/body) 121 | map) 122 | "Keymap for VUnit Hydra.") 123 | 124 | (defvar vunit-flags '() 125 | "Additional flags for the python script.") 126 | 127 | (defvar vunit--testcasestring "" 128 | "Internal variable that is used to store the previous testcasestring.") 129 | 130 | (defconst vunit--regex-testcase "run\s*(\"\\([^\"]*\\)\")" 131 | "Regular expression for testcases.") 132 | 133 | (defconst vunit--temporary-buffer-name "*vunit-mode*" 134 | "Name for temporary buffer for testcase selection.") 135 | 136 | (defconst vunit--testcase-library-begin "lib." 137 | "Beginning of testcase identifiers after vunit list.") 138 | 139 | ;;; internal functions 140 | 141 | (defun vunit-open-script () 142 | "Open vunit script." 143 | (interactive) 144 | (find-file-other-window (vunit--run-script-path))) 145 | 146 | (defun vunit-compile () 147 | "Compile all modules." 148 | (interactive) 149 | (vunit--run "--compile")) 150 | 151 | (defun vunit-clean () 152 | "Clean output products." 153 | (interactive) 154 | (vunit--run "--clean")) 155 | 156 | (defun vunit-files () 157 | "List all files in compile order." 158 | (interactive) 159 | (vunit--run "--files")) 160 | 161 | (defun vunit-list () 162 | "List all testcases." 163 | (interactive) 164 | (vunit--run "--list")) 165 | 166 | (defun vunit-sim () 167 | "Simulate with filter." 168 | (interactive) 169 | (vunit--run (read-string "Testcase: "))) 170 | 171 | (defun vunit-sim-new-selection () 172 | "List all Testcases for Selcetion and run selected." 173 | (interactive) 174 | ;;check if the buffer already exists and kill it if it exists 175 | (when (get-buffer-window vunit--temporary-buffer-name) 176 | (switch-to-buffer vunit--temporary-buffer-name) 177 | (kill-buffer-and-window)) 178 | (when (get-buffer vunit--temporary-buffer-name) 179 | (kill-buffer vunit--temporary-buffer-name)) 180 | ;;create new buffer fo testcase selection 181 | (get-buffer-create vunit--temporary-buffer-name) 182 | (switch-to-buffer-other-window vunit--temporary-buffer-name) 183 | (delete-all-overlays) 184 | (let ((inhibit-read-only t)) 185 | (erase-buffer)) 186 | (kill-all-local-variables) 187 | ;;get the testcases using vunit 188 | (let* (beginpos endpos testcasestring testcases coding-str checkboxes (end nil) firstselectionpos) 189 | (insert (shell-command-to-string (vunit--format-call-string "--list"))) 190 | (setq vunit--testcasestring "") 191 | (setq coding-str (symbol-name buffer-file-coding-system)) 192 | ;;make sure the output is unix encoded 193 | (when (string-match "-\\(?:dos\\|mac\\)$" coding-str) 194 | (set-buffer-file-coding-system 'unix)) 195 | (goto-char (point-min)) 196 | (while (and (not (looking-at vunit--testcase-library-begin)) 197 | (not end)) 198 | (forward-line) 199 | (move-end-of-line 1) 200 | (setq end (eobp)) 201 | (move-beginning-of-line 1)) 202 | (setq beginpos (point)) 203 | (while (and (looking-at vunit--testcase-library-begin) 204 | (not (eq t end))) 205 | (forward-line 1) 206 | (move-end-of-line 1) 207 | (setq end (eobp)) 208 | (move-beginning-of-line 1)) 209 | (if (looking-at vunit--testcase-library-begin) 210 | (move-end-of-line 1)) 211 | (setq endpos (point)) 212 | (setq testcasestring (buffer-substring beginpos endpos)) 213 | (if (eq testcasestring "") 214 | (progn 215 | (vunit--kill-buffer-and-window) 216 | (error "No Testcases were found"))) 217 | (erase-buffer) 218 | (setq testcases (split-string testcasestring "\n" t)) 219 | (setq inhibit-read-only nil) 220 | (if (or (not testcases) 221 | (eq "" testcasestring)) 222 | (progn 223 | (vunit--kill-buffer-and-window) 224 | (error "No Testcases were found"))) 225 | (remove-overlays) 226 | ;; insert selection widgets for testcases 227 | (widget-insert "Select Testcases below\n\n") 228 | (setq firstselectionpos (point)) 229 | (dolist (testcase testcases) 230 | (push (widget-create 'toggle 231 | :on (format "%s %s" "[X]" testcase) 232 | :off (format "%s %s" "[ ]" testcase)) 233 | checkboxes) ) 234 | (setq checkboxes (nreverse checkboxes)) 235 | (widget-insert "\n\n") 236 | (widget-create 'push-button 237 | :notify (lambda (wid &rest ignore) 238 | (ignore wid) 239 | (ignore ignore) 240 | (let* ((first t) (cases testcases)) 241 | (setq vunit--testcasestring "") 242 | (dolist (checkbox checkboxes) 243 | (when (widget-value checkbox) 244 | (when (not first) 245 | (setq vunit--testcasestring (concat vunit--testcasestring " "))) 246 | (setq vunit--testcasestring (concat vunit--testcasestring (format "\"%s\"" (car cases)))) 247 | (setq first nil)) 248 | (setq cases (cdr cases))) 249 | (vunit--kill-buffer-and-window) 250 | (unless (string-equal vunit--testcasestring "") 251 | (vunit--run vunit--testcasestring)))) 252 | "Run Selected Testcases") 253 | (widget-insert "\n") 254 | (widget-create 'push-button 255 | :notify (lambda (wid &rest ignore) 256 | (ignore wid) 257 | (ignore ignore) 258 | (kill-buffer-and-window)) 259 | "Exit") 260 | (use-local-map widget-keymap) 261 | (widget-setup) 262 | (goto-char firstselectionpos) 263 | (forward-char 1))) 264 | 265 | (defun vunit-sim-previous-selection () 266 | "Simulate the previously selected testcases. 267 | If none were selected start new selection." 268 | (interactive) 269 | (if (string-equal vunit--testcasestring "") 270 | (vunit-sim-new-selection) 271 | (vunit--run vunit--testcasestring))) 272 | 273 | (defun vunit-sim-all () 274 | "Simulate all modules." 275 | (interactive) 276 | (vunit--run "")) 277 | 278 | (defun vunit-sim-file () 279 | "Simulate currently opened file/buffer." 280 | (interactive) 281 | (let* (entity entitypos entityendpos) 282 | (save-excursion 283 | ;; search for the first definition of an entity 284 | (goto-char (point-min)) 285 | (while (setq entitypos (re-search-forward "entity" nil t)) 286 | (move-beginning-of-line 1) 287 | (skip-chars-forward " \t\n\r\f") 288 | (if (looking-at "entity") 289 | (progn 290 | ;; get the name of the entity 291 | (goto-char entitypos) 292 | (skip-chars-forward " \t\n\r\f") 293 | (setq entitypos (point)) 294 | (skip-chars-forward "[[:graph:]]") 295 | (setq entityendpos (point)) 296 | (skip-chars-forward " \t\n\r\f") 297 | (when (looking-at "is") 298 | (setq entity (buffer-substring entitypos entityendpos)) 299 | ;;end the loop now as we have found an entity 300 | (goto-char (point-max)))) 301 | (goto-char entitypos)))) 302 | (if (or (string-equal entity "") 303 | (not entity)) 304 | (error "No suitable Entity found") 305 | (vunit--run (format "'*.%s.*'" entity))))) 306 | 307 | (defun vunit-sim-cursor () 308 | "Simulate testcase at cursor." 309 | (interactive) 310 | (with-current-buffer (buffer-name) 311 | (save-excursion 312 | (if (not (vunit--match-line)) 313 | (re-search-backward vunit--regex-testcase nil 'noerror)) 314 | (if (vunit--match-line) 315 | (vunit--run (format "'*.%s'" (vunit--match-line))) 316 | (message "No testcase..."))))) 317 | 318 | (defun vunit--format-call-string (param) 319 | "Format the VUnit call-string with `PARAM'." 320 | (format "%s%s %s %s --output-path %s --num-threads %d %s %s" 321 | (if vunit-simulator (concat "VUNIT_SIMULATOR=" vunit-simulator " ") "") 322 | vunit-python-executable 323 | (vunit--run-script-path) 324 | param 325 | (vunit--run-outdir-path) 326 | vunit-num-threads 327 | (vunit--flag-to-string) 328 | vunit-extra-flags)) 329 | 330 | 331 | (defun vunit--kill-buffer-and-window () 332 | "Delete the temporary Buffer and window if present." 333 | (when (get-buffer-window vunit--temporary-buffer-name) 334 | (switch-to-buffer vunit--temporary-buffer-name) 335 | (kill-buffer-and-window)) 336 | (when (get-buffer vunit--temporary-buffer-name) 337 | (kill-buffer vunit--temporary-buffer-name))) 338 | 339 | (defun vunit--run (param) 340 | "Run VUnit python script with `PARAM'." 341 | (let ((default-directory (or vunit-path (vunit-get-path)))) 342 | (compile (vunit--format-call-string param)))) 343 | 344 | (defun vunit--run-script-path () 345 | "Full absolute path to the run script." 346 | (when (not vunit-path) 347 | (vunit-get-path)) 348 | (expand-file-name vunit-run-script vunit-path)) 349 | 350 | (defun vunit--run-outdir-path () 351 | "Full absolute path to the output directory." 352 | (when (not vunit-path) 353 | (vunit-get-path)) 354 | (expand-file-name vunit-run-outdir vunit-path)) 355 | 356 | (defun vunit-get-path () 357 | "Parse for VUnit directory." 358 | (interactive) 359 | (setq vunit-path (read-directory-name "Select VUnit Path: "))) 360 | 361 | (defun vunit--match-line () 362 | "Simulate the testcase at the current line." 363 | (let ((linestring (thing-at-point 'line t))) 364 | (if (string-match vunit--regex-testcase linestring) 365 | (match-string 1 linestring)))) 366 | 367 | (defun vunit-toggle-flag (flag) 368 | "Remove or Add `FLAG' to the command and message back." 369 | (interactive) 370 | (if (vunit--flag-enabled flag) 371 | (vunit--rm-flag flag) 372 | (vunit--add-flag flag)) 373 | (vunit--flag-enabled-message)) 374 | 375 | (defun vunit--flag-enabled-message () 376 | "Message activated flags." 377 | (message "Flags: %s" (vunit--flag-to-string))) 378 | 379 | (defun vunit--flag-to-string () 380 | "Return string representation of list." 381 | (mapconcat #'identity vunit-flags " ")) 382 | 383 | (defun vunit--flag-enabled (flag) 384 | "Return t if `FLAG' is set, nil otherwise." 385 | (member flag vunit-flags)) 386 | 387 | (defun vunit--add-flag (flag) 388 | "Add `FLAG' for the python script run." 389 | (add-to-list 'vunit-flags flag)) 390 | 391 | (defun vunit--rm-flag (flag) 392 | "Remove `FLAG' for the python script run." 393 | (setq vunit-flags (delete flag vunit-flags))) 394 | 395 | ;;;###autoload 396 | (define-minor-mode vunit-mode 397 | "Minor Mode to interface with VUnit script." 398 | :group 'vunit 399 | :lighter " VUnit" 400 | :keymap vunit-mode-map) 401 | 402 | ;;;###autoload 403 | (define-globalized-minor-mode global-vunit-mode 404 | vunit-mode vunit--turn-on) 405 | 406 | (defun vunit--turn-on () 407 | "Bind the variable `vunit-mode' to the `vhdl-mode'." 408 | (when (derived-mode-p 'vhdl-mode) 409 | (vunit-mode 1))) 410 | 411 | ;;;###autoload(autoload 'vunit-buffer-menu/body "vunit-mode") 412 | (defhydra vunit-buffer-menu 413 | (:color blue 414 | :pre (vunit--flag-enabled-message)) 415 | " 416 | ^Basic^ ^Compile^ ^Simulate^ ^Flags^ 417 | ^^^^^^^------------------------------------------------------------------------------- 418 | _o_: Open Script _c_: All _a_: All _g_: GUI 419 | _r_: List Tests ^ ^ _s_: Filter _v_: Verbose 420 | _f_: List Files ^ ^ _b_: Buffer _e_: Keep-Compiling 421 | _x_: Clean ^ ^ _t_: Cursor _p_: Fail-Fast 422 | ^ ^ ^ ^ _n_: New Selection _d_: Debug 423 | ^ ^ ^ ^ _l_: Previous Selection ^ ^ 424 | ^ ^ ^ ^ ^ ^ ^ ^ 425 | ^ ^ 426 | " 427 | ("o" vunit-open-script nil) 428 | ("r" vunit-list nil) 429 | ("f" vunit-files nil) 430 | ("c" vunit-compile nil) 431 | ("x" vunit-clean nil) 432 | ("b" vunit-sim-file nil) 433 | ("t" vunit-sim-cursor nil) 434 | ("n" vunit-sim-new-selection nil) 435 | ("l" vunit-sim-previous-selection nil) 436 | ("a" vunit-sim-all nil) 437 | ("s" vunit-sim nil) 438 | ("g" (vunit-toggle-flag vunit--flag-gui) nil :color pink) 439 | ("v" (vunit-toggle-flag vunit--flag-verbose) nil :color pink) 440 | ("e" (vunit-toggle-flag vunit--flag-keep-compiling) nil :color pink) 441 | ("p" (vunit-toggle-flag vunit--flag-fail-fast) nil :color pink) 442 | ("d" (vunit-toggle-flag vunit--flag-log-level) nil :color pink)) 443 | 444 | (easy-menu-define vunit-menu vunit-mode-map 445 | "Vunit Menu" 446 | '("Vunit" 447 | :visible vunit-mode 448 | ("Basic" 449 | :help "Basic commands" 450 | ["Open Script" vunit-open-script 451 | :help "Open vunit script"] 452 | ["List Tests" vunit-list 453 | :help "List all testcases"] 454 | ["List Files" vunit-files 455 | :help "List all files in compile order"] 456 | ["Clean" vunit-clean 457 | :help "Clean output products"]) 458 | ("Compile" 459 | :help "Compile commands" 460 | ["All" vunit-compile 461 | :help "Compile all modules"]) 462 | ("Simulate" 463 | :help "Simulation commands" 464 | ["All" vunit-sim-all 465 | :help "Simulate all modules"] 466 | ["Filter" vunit-sim 467 | :help "Simulate with filter"] 468 | ["New Selection" vunit-sim-new-selection 469 | :help "Simulate with visual Testcaseselection"] 470 | ["Last Selection" vunit-sim-previous-selection 471 | :help "Simulate previously selected testcase or new selection if none were selected"] 472 | ["Buffer" vunit-sim-file 473 | :help "Simulate current file/buffer"] 474 | ["Cursor" vunit-sim-cursor 475 | :help "Simulate testcase at cursor"]) 476 | ("Flags" 477 | :help "Flags set for the command to run" 478 | [vunit--flag-gui 479 | (vunit-toggle-flag vunit--flag-gui) 480 | :help "Open GUI" 481 | :style toggle 482 | :selected (vunit--flag-enabled vunit--flag-gui)] 483 | [vunit--flag-verbose 484 | (vunit-toggle-flag vunit--flag-verbose) 485 | :help "Verbose" 486 | :style toggle 487 | :selected (vunit--flag-enabled vunit--flag-verbose)] 488 | [vunit--flag-keep-compiling 489 | (vunit-toggle-flag vunit--flag-keep-compiling) 490 | :help "Keep-Compiling" 491 | :style toggle 492 | :selected (vunit--flag-enabled vunit--flag-keep-compiling)] 493 | [vunit--flag-fail-fast 494 | (vunit-toggle-flag vunit--flag-fail-fast) 495 | :help "Fail-fast" 496 | :style toggle 497 | :selected (vunit--flag-enabled vunit--flag-fail-fast)] 498 | [vunit--flag-log-level 499 | (vunit-toggle-flag vunit--flag-log-level) 500 | :help "Log-level Debug" 501 | :style toggle 502 | :selected (vunit--flag-enabled vunit--flag-log-level)]))) 503 | 504 | (provide 'vunit-mode) 505 | 506 | ;;; vunit-mode.el ends here 507 | 508 | ;; Silence all the hydra docstring byte-compiler warnings: 509 | ;; 510 | ;; Local Variables: 511 | ;; byte-compile-warnings: (not docstrings) 512 | ;; End: 513 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | . --------------------------------------------------------------------------------