├── test ├── resources │ ├── checkers │ │ ├── c_c++-clang-header.h │ │ ├── less-syntax-error.less │ │ ├── haskell-hdevtools-error.hs │ │ ├── config-files │ │ │ ├── flake8rc │ │ │ ├── rubocop.yml │ │ │ └── coffeelint.json │ │ ├── haskell-ghc-error.hs │ │ ├── c_c++-clang-fatal-error.c │ │ ├── haskell-ghc-warning.hs │ │ ├── haskell-hlint-warning.hs │ │ ├── perl-error.pl │ │ ├── rust-syntax-error.rs │ │ ├── haskell-hdevtools-warning.hs │ │ ├── python-syntax-error.py │ │ ├── c_c++-cppcheck-warning.c │ │ ├── python-pylint-warning.py │ │ ├── emacs-lisp-error.el │ │ ├── package.d │ │ ├── scss-error.scss │ │ ├── javascript-jshint-error.js │ │ ├── perl-syntax-error.pl │ │ ├── javascript-jshint-syntax-error.js │ │ ├── c_c++-cppcheck-error.c │ │ ├── go-syntax-error.go │ │ ├── puppet-lint │ │ │ └── error │ │ │ │ └── manifests │ │ │ │ └── puppet-lint-error.pp │ │ ├── python-flake8-warning.py │ │ ├── python-pylint-error.py │ │ ├── ruby-warning.rb │ │ ├── sass-error.sass │ │ ├── scala-syntax-error.scala │ │ ├── sh-bash-syntax-error.sh │ │ ├── less-file-error.less │ │ ├── css-syntax-error.css │ │ ├── d-dmd-warning.d │ │ ├── haskell-hlint-error.hs │ │ ├── d_dmd_syntax_error_without_module.d │ │ ├── json-jsonlint-error.json │ │ ├── coffee-coffeelint-error.coffee │ │ ├── coffee-syntax-error.coffee │ │ ├── css-csslint-warning.css │ │ ├── ruby-rubocop-warnings.rb │ │ ├── haml-error.haml │ │ ├── puppet-parser-singleline.pp │ │ ├── bash-syntax-error.bash │ │ ├── javascript-jshint-warning.js │ │ ├── zsh-syntax-error.zsh │ │ ├── emacs-lisp-syntax-error.el.gz │ │ ├── rst-error.rst │ │ ├── rst-severe.rst │ │ ├── sh-dash-syntax-error.sh │ │ ├── d-dmd-syntax-error.d │ │ ├── emacs-lisp-checkdoc-warning.el.gz │ │ ├── go-testpackage │ │ │ ├── go-build-error.go │ │ │ └── go-test-error_test.go │ │ ├── lua-syntax-error.lua │ │ ├── elixir-error.ex │ │ ├── python-flake8-error.py │ │ ├── c_c++-cppcheck-style.c │ │ ├── emacs-lisp-syntax-error.el │ │ ├── xml-syntax-error.xml │ │ ├── c_c++-clang-warning.c │ │ ├── c_c++-clang-error.cpp │ │ ├── python-flake8-error-maximum-line-length.py │ │ ├── ruby-syntax-error.rb │ │ ├── d-dmd-deprecated.d │ │ ├── emacs-lisp-warning.el │ │ ├── erlang-warning.erl │ │ ├── rst-warning.rst │ │ ├── erlang-error.erl │ │ ├── puppet-lint-warning.pp │ │ ├── tex-lacheck-warning.tex │ │ ├── html-tidy-warning-and-error.html │ │ ├── php-syntax-error.php │ │ ├── python-flake8-warning-naming.py │ │ ├── tex-chktex-warning.tex │ │ ├── c_c++-cppcheck-multiple-checks.cpp │ │ ├── puppet-parser-multiline.pp │ │ ├── python-flake8-warning-maximum-complexity.py │ │ ├── elixir-warnings.ex │ │ ├── php-phpcs-error.php │ │ └── emacs-lisp-checkdoc-warning.el │ ├── automatic-check-dummy.el │ ├── substitute-dummy │ ├── global-mode-dummy.el │ ├── dummy-elpa │ │ └── dummy-package-0.1 │ │ │ ├── dummy-package-pkg.el │ │ │ ├── dummy-package.el │ │ │ └── dummy-package-autoloads.el │ ├── errors-from-different-checkers.py │ ├── many-errors-for-error-list.el │ ├── many-errors-for-navigation.el │ ├── chained-errors.el │ └── narrowing.el ├── .dir-locals.el └── test-helper.el ├── doc ├── screenshot.png ├── htmlxref.cnf ├── flycheck.css └── fdl-1.3.texi ├── .librarian └── puppet │ └── config ├── puppet ├── manifests │ ├── site.pp │ └── travis.pp ├── modules │ ├── flycheck │ │ └── manifests │ │ │ ├── checkers │ │ │ ├── go.pp │ │ │ ├── php.pp │ │ │ ├── gems.pp │ │ │ ├── ruby.pp │ │ │ ├── haskell.pp │ │ │ ├── nodejs.pp │ │ │ ├── erlang.pp │ │ │ └── python.pp │ │ │ ├── base.pp │ │ │ └── checkers.pp │ └── README.md └── bootstrap.sh ├── Puppetfile ├── .dir-locals.el ├── .gitignore ├── Vagrantfile ├── Puppetfile.lock ├── .travis.yml ├── Cask ├── CONTRIBUTING.md ├── Makefile ├── README.md └── COPYING /test/resources/checkers/c_c++-clang-header.h: -------------------------------------------------------------------------------- 1 | #define FOO 2 | -------------------------------------------------------------------------------- /test/resources/checkers/less-syntax-error.less: -------------------------------------------------------------------------------- 1 | .{something {} 2 | -------------------------------------------------------------------------------- /test/resources/checkers/haskell-hdevtools-error.hs: -------------------------------------------------------------------------------- 1 | main = unknown 2 | -------------------------------------------------------------------------------- /test/resources/checkers/config-files/flake8rc: -------------------------------------------------------------------------------- 1 | [flake8] 2 | ignore=E251,F401 3 | -------------------------------------------------------------------------------- /test/resources/checkers/haskell-ghc-error.hs: -------------------------------------------------------------------------------- 1 | bogus 2 | 3 | module Foo where 4 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-clang-fatal-error.c: -------------------------------------------------------------------------------- 1 | #include 2 | -------------------------------------------------------------------------------- /doc/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/magnars/flycheck/master/doc/screenshot.png -------------------------------------------------------------------------------- /test/resources/automatic-check-dummy.el: -------------------------------------------------------------------------------- 1 | A dummy file to test automatic syntax checking 2 | -------------------------------------------------------------------------------- /test/resources/substitute-dummy: -------------------------------------------------------------------------------- 1 | A dummy file used in substitution tests in test-checker-api.el -------------------------------------------------------------------------------- /test/resources/checkers/haskell-ghc-warning.hs: -------------------------------------------------------------------------------- 1 | module Foo where 2 | 3 | foo = 10 :: Integer 4 | -------------------------------------------------------------------------------- /test/resources/checkers/haskell-hlint-warning.hs: -------------------------------------------------------------------------------- 1 | main :: IO () 2 | main = (putStrLn "Foobar") 3 | -------------------------------------------------------------------------------- /test/resources/checkers/perl-error.pl: -------------------------------------------------------------------------------- 1 | # An unused variable 2 | 3 | use warnings; 4 | $x = 10; 5 | -------------------------------------------------------------------------------- /test/resources/checkers/rust-syntax-error.rs: -------------------------------------------------------------------------------- 1 | // A simple syntax error 2 | 3 | fn main() bla 4 | -------------------------------------------------------------------------------- /test/resources/checkers/haskell-hdevtools-warning.hs: -------------------------------------------------------------------------------- 1 | module Foo where 2 | 3 | foo = 10 :: Integer 4 | -------------------------------------------------------------------------------- /test/resources/checkers/python-syntax-error.py: -------------------------------------------------------------------------------- 1 | # A straight syntax error 2 | 3 | foo = import bar 4 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-cppcheck-warning.c: -------------------------------------------------------------------------------- 1 | bool f(bool x, int y) { 2 | return x == y; 3 | } 4 | -------------------------------------------------------------------------------- /test/resources/checkers/python-pylint-warning.py: -------------------------------------------------------------------------------- 1 | # Use the builtin "map()" 2 | 3 | map(str, range(10)) 4 | -------------------------------------------------------------------------------- /test/resources/global-mode-dummy.el: -------------------------------------------------------------------------------- 1 | A dummy file to test whether the global mode can be enabled or not 2 | -------------------------------------------------------------------------------- /.librarian/puppet/config: -------------------------------------------------------------------------------- 1 | --- 2 | LIBRARIAN_PUPPET_DESTRUCTIVE: "false" 3 | LIBRARIAN_PUPPET_PATH: puppet/lib -------------------------------------------------------------------------------- /test/resources/checkers/emacs-lisp-error.el: -------------------------------------------------------------------------------- 1 | ;; Error from a missing package 2 | 3 | (require 'dummy-package) 4 | -------------------------------------------------------------------------------- /test/resources/checkers/package.d: -------------------------------------------------------------------------------- 1 | // A dummy D package file to test base calculation 2 | 3 | module checkers; -------------------------------------------------------------------------------- /test/resources/checkers/scss-error.scss: -------------------------------------------------------------------------------- 1 | #container { 2 | &.error { 3 | c olor: red; 4 | } 5 | } -------------------------------------------------------------------------------- /test/resources/checkers/javascript-jshint-error.js: -------------------------------------------------------------------------------- 1 | /** Use eval to trigger a warning */ 2 | 3 | eval("alert();"); 4 | -------------------------------------------------------------------------------- /test/resources/checkers/perl-syntax-error.pl: -------------------------------------------------------------------------------- 1 | # A syntax error 2 | 3 | use strict 4 | use warnings; 5 | $x = 10; 6 | -------------------------------------------------------------------------------- /test/resources/checkers/config-files/rubocop.yml: -------------------------------------------------------------------------------- 1 | # Disable snake case for symbol 2 | SymbolName: 3 | Enabled: false 4 | -------------------------------------------------------------------------------- /test/resources/checkers/javascript-jshint-syntax-error.js: -------------------------------------------------------------------------------- 1 | /** A missing semicolon */ 2 | 3 | var foo = "Hello world); 4 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-cppcheck-error.c: -------------------------------------------------------------------------------- 1 | int derefNull(void) 2 | { 3 | int* nil = NULL; 4 | return *nil; 5 | } 6 | -------------------------------------------------------------------------------- /test/resources/checkers/go-syntax-error.go: -------------------------------------------------------------------------------- 1 | // A simple syntax error in Go 2 | 3 | package main 4 | 5 | func ta ta() { 6 | } -------------------------------------------------------------------------------- /test/resources/checkers/puppet-lint/error/manifests/puppet-lint-error.pp: -------------------------------------------------------------------------------- 1 | # this is a pretend class 2 | class mlayout { 3 | } 4 | -------------------------------------------------------------------------------- /test/resources/checkers/python-flake8-warning.py: -------------------------------------------------------------------------------- 1 | # Do not use an import 2 | 3 | import re 4 | 5 | print('how are you') 6 | -------------------------------------------------------------------------------- /test/resources/checkers/python-pylint-error.py: -------------------------------------------------------------------------------- 1 | # Importing an unknown module 2 | 3 | import spam 4 | 5 | spam.with_eggs() 6 | -------------------------------------------------------------------------------- /test/resources/checkers/ruby-warning.rb: -------------------------------------------------------------------------------- 1 | # generates warning 'possibly useless use of == in void context' 2 | 3 | test == 20 4 | -------------------------------------------------------------------------------- /test/resources/checkers/sass-error.sass: -------------------------------------------------------------------------------- 1 | // A syntax error caused by inconsistent indentation 2 | 3 | .a 4 | .b 5 | .c 6 | -------------------------------------------------------------------------------- /test/resources/checkers/scala-syntax-error.scala: -------------------------------------------------------------------------------- 1 | // Scala syntax error 2 | 3 | object { 4 | println("hello, world") 5 | } 6 | -------------------------------------------------------------------------------- /test/resources/checkers/sh-bash-syntax-error.sh: -------------------------------------------------------------------------------- 1 | # A syntax error caused by a Bash-only redirection 2 | 3 | cat <(echo blah) 4 | -------------------------------------------------------------------------------- /test/resources/dummy-elpa/dummy-package-0.1/dummy-package-pkg.el: -------------------------------------------------------------------------------- 1 | (define-package "dummy-package" "0.1" "Dummy package" 'nil) 2 | -------------------------------------------------------------------------------- /test/resources/errors-from-different-checkers.py: -------------------------------------------------------------------------------- 1 | # Do not use an import 2 | 3 | import re 4 | 5 | print('how are you') 6 | -------------------------------------------------------------------------------- /puppet/manifests/site.pp: -------------------------------------------------------------------------------- 1 | # The main manifest for test provisioning 2 | 3 | include flycheck::base 4 | include flycheck::checkers 5 | -------------------------------------------------------------------------------- /test/resources/checkers/less-file-error.less: -------------------------------------------------------------------------------- 1 | .something {} 2 | 3 | @import "no-such-file.less"; 4 | 5 | #otherthing { 6 | } 7 | -------------------------------------------------------------------------------- /test/resources/checkers/css-syntax-error.css: -------------------------------------------------------------------------------- 1 | /** A syntax error caused by a missing brace. */ 2 | 3 | h1 4 | font-size: 100%; 5 | } -------------------------------------------------------------------------------- /test/resources/checkers/d-dmd-warning.d: -------------------------------------------------------------------------------- 1 | module d_dmd_warning; 2 | 3 | auto foo(int a) 4 | { 5 | return a; 6 | return a; 7 | } 8 | -------------------------------------------------------------------------------- /test/resources/checkers/haskell-hlint-error.hs: -------------------------------------------------------------------------------- 1 | module Foo 2 | where 3 | warnMe :: [String] -> [[String]] 4 | warnMe xs = map lines xs 5 | -------------------------------------------------------------------------------- /test/resources/checkers/d_dmd_syntax_error_without_module.d: -------------------------------------------------------------------------------- 1 | import std.stdio; 2 | 3 | void main() 4 | { 5 | writel("Hello"); 6 | } 7 | -------------------------------------------------------------------------------- /test/resources/checkers/json-jsonlint-error.json: -------------------------------------------------------------------------------- 1 | { "Comment": "Test two top-level objects"}, 2 | { "Comment": "This object is misplaced" } 3 | -------------------------------------------------------------------------------- /test/resources/checkers/coffee-coffeelint-error.coffee: -------------------------------------------------------------------------------- 1 | # An error/warning caused by throwing a string 2 | 3 | foo = () -> 4 | throw "Hello world" -------------------------------------------------------------------------------- /test/resources/checkers/coffee-syntax-error.coffee: -------------------------------------------------------------------------------- 1 | # A syntax error caused by a missing quote 2 | 3 | foo = () -> 4 | bar "Hello world 5 | 1 + 1 -------------------------------------------------------------------------------- /test/resources/checkers/css-csslint-warning.css: -------------------------------------------------------------------------------- 1 | /** A warning triggered by a qualified heading. */ 2 | 3 | .foo h1 { 4 | font-size: 100%; 5 | } -------------------------------------------------------------------------------- /test/resources/checkers/ruby-rubocop-warnings.rb: -------------------------------------------------------------------------------- 1 | # Triggers some warnings in RuboCop 2 | 3 | arr = [:one, :twoTho, :top_gun] 4 | puts "test" 5 | -------------------------------------------------------------------------------- /doc/htmlxref.cnf: -------------------------------------------------------------------------------- 1 | ert mono http://www.gnu.org/software/emacs/manual/html_mono/ert.html 2 | ert node http://www.gnu.org/software/emacs/manual/html_node/ert/ -------------------------------------------------------------------------------- /test/resources/checkers/haml-error.haml: -------------------------------------------------------------------------------- 1 | -# A syntax error caused by inconsistent indentation 2 | 3 | %html 4 | %head 5 | %title Bad indent! 6 | -------------------------------------------------------------------------------- /test/resources/checkers/puppet-parser-singleline.pp: -------------------------------------------------------------------------------- 1 | # Test single line error message 2 | class {'parser_err1': 3 | hello => 'something',, 4 | } 5 | -------------------------------------------------------------------------------- /test/resources/checkers/bash-syntax-error.bash: -------------------------------------------------------------------------------- 1 | # A syntax error resulting from a missing semicolon 2 | 3 | if true then 4 | echo "Hello World" 5 | fi 6 | -------------------------------------------------------------------------------- /test/resources/checkers/javascript-jshint-warning.js: -------------------------------------------------------------------------------- 1 | /** An unused variable */ 2 | 3 | 4 | (function() { 5 | var foo = ["Hello world"]; 6 | }()); 7 | -------------------------------------------------------------------------------- /test/resources/checkers/zsh-syntax-error.zsh: -------------------------------------------------------------------------------- 1 | # A syntax error resulting from a missing semicolon 2 | 3 | if true then 4 | echo "Hello World" 5 | fi 6 | -------------------------------------------------------------------------------- /test/resources/checkers/emacs-lisp-syntax-error.el.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/magnars/flycheck/master/test/resources/checkers/emacs-lisp-syntax-error.el.gz -------------------------------------------------------------------------------- /test/resources/checkers/rst-error.rst: -------------------------------------------------------------------------------- 1 | ============= 2 | Hello world 3 | ============= 4 | 5 | Let us check ReStructuredText_. 6 | 7 | Really, it's cool_! 8 | -------------------------------------------------------------------------------- /test/resources/checkers/rst-severe.rst: -------------------------------------------------------------------------------- 1 | Hello, there: 2 | 3 | .. warning:: 4 | 5 | Foo 6 | === 7 | 8 | .. note:: 9 | 10 | Bar 11 | === 12 | -------------------------------------------------------------------------------- /test/resources/checkers/sh-dash-syntax-error.sh: -------------------------------------------------------------------------------- 1 | # A syntax error resulting from a missing semicolon 2 | 3 | if true then 4 | echo "Hello World" 5 | fi 6 | -------------------------------------------------------------------------------- /test/resources/checkers/d-dmd-syntax-error.d: -------------------------------------------------------------------------------- 1 | module d_dmd_syntax_error; 2 | import std.studio; 3 | 4 | void main() 5 | { 6 | writeln("Hello, world!"); 7 | } 8 | -------------------------------------------------------------------------------- /test/resources/checkers/emacs-lisp-checkdoc-warning.el.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/magnars/flycheck/master/test/resources/checkers/emacs-lisp-checkdoc-warning.el.gz -------------------------------------------------------------------------------- /test/resources/checkers/go-testpackage/go-build-error.go: -------------------------------------------------------------------------------- 1 | // A simple import error in Go 2 | 3 | package testpackage 4 | 5 | func Foo() { 6 | fmt.Println("foo") 7 | } 8 | -------------------------------------------------------------------------------- /test/resources/checkers/lua-syntax-error.lua: -------------------------------------------------------------------------------- 1 | -- A syntax error caused by a missing quote 2 | -- 3 | -- Checkers: lua 4 | 5 | print "oh no 6 | 7 | print "hello world" 8 | -------------------------------------------------------------------------------- /test/resources/checkers/elixir-error.ex: -------------------------------------------------------------------------------- 1 | # Test an error from Elixir 2 | 3 | defmodule AnError do 4 | def error_func do 5 | puts "Flycheck is great!" 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /test/resources/checkers/python-flake8-error.py: -------------------------------------------------------------------------------- 1 | # Add superfluous spaces around an operator 2 | # 3 | # Checkers: Flake8 4 | 5 | 6 | def foo(spam = 'eggs'): 7 | pass 8 | -------------------------------------------------------------------------------- /test/resources/dummy-elpa/dummy-package-0.1/dummy-package.el: -------------------------------------------------------------------------------- 1 | ;;;###autoload 2 | (defun dummy-package-foo () 3 | (message "Hello world")) 4 | 5 | (provide 'dummy-package) 6 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-cppcheck-style.c: -------------------------------------------------------------------------------- 1 | int f(int x) 2 | { 3 | int unused; 4 | // cppcheck-suppress unusedVariable 5 | int unused2; 6 | return x * 2; 7 | } 8 | -------------------------------------------------------------------------------- /test/resources/checkers/emacs-lisp-syntax-error.el: -------------------------------------------------------------------------------- 1 | ;; A syntax error caused by a missing parenthesis -*- lexical-binding: t; -*- 2 | 3 | (message (concat "Hello " user-full-name) 4 | -------------------------------------------------------------------------------- /test/resources/checkers/xml-syntax-error.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-clang-warning.c: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | int f(int x) 4 | { 5 | int unused; 6 | unsigned int y = 10; 7 | return x < y ? ++x : x; 8 | } 9 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-clang-error.cpp: -------------------------------------------------------------------------------- 1 | template struct test; 2 | template<> struct test {}; 3 | 4 | int main(void) { 5 | test t; 6 | return 0; 7 | } 8 | -------------------------------------------------------------------------------- /puppet/manifests/travis.pp: -------------------------------------------------------------------------------- 1 | # Install all Ruby Gems. Intended for Travis CI, where we need to install Gems 2 | # as normal user to not mess up with RVM. 3 | 4 | include flycheck::checkers::gems 5 | -------------------------------------------------------------------------------- /test/resources/checkers/python-flake8-error-maximum-line-length.py: -------------------------------------------------------------------------------- 1 | # Test a very long line 2 | 3 | our_chicken_stable = [] 4 | 5 | eggs = [chicken.make_egg() for chicken in our_chicken_stable] 6 | -------------------------------------------------------------------------------- /test/resources/checkers/ruby-syntax-error.rb: -------------------------------------------------------------------------------- 1 | # A syntax error caused by a missing quote 2 | # Taken from http://stackoverflow.com/a/7317453/355252 3 | 4 | days = "abc 5 | puts "Here are the days" 6 | -------------------------------------------------------------------------------- /test/resources/checkers/d-dmd-deprecated.d: -------------------------------------------------------------------------------- 1 | module d_dmd_deprecated; 2 | 3 | deprecated 4 | auto foo(int a) 5 | { 6 | return a; 7 | } 8 | 9 | void main() 10 | { 11 | auto bar = foo(1); 12 | } 13 | -------------------------------------------------------------------------------- /test/resources/checkers/emacs-lisp-warning.el: -------------------------------------------------------------------------------- 1 | ;; A warning error caused by a missing argument -*- lexical-binding: t; -*- 2 | 3 | (if t 4 | (message) 5 | (message "Hello foo")) 6 | 7 | (dummy-package-foo) 8 | -------------------------------------------------------------------------------- /test/resources/checkers/erlang-warning.erl: -------------------------------------------------------------------------------- 1 | %% Warning from Erlang 2 | -module('erlang-warning'). 3 | -compile(export_all). 4 | 5 | simple_warning() -> 6 | io:format("Flycheck is great!", ["unused argument"]). 7 | -------------------------------------------------------------------------------- /test/resources/checkers/rst-warning.rst: -------------------------------------------------------------------------------- 1 | ============= 2 | Hello world 3 | ============= 4 | 5 | Lorem ipsum. 6 | 7 | A title with short underline 8 | ==== 9 | 10 | Oh now, this one is too 11 | ---- 12 | -------------------------------------------------------------------------------- /Puppetfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby; -*- 2 | 3 | forge 'http://forge.puppetlabs.com' 4 | 5 | mod 'puppetlabs/apt' 6 | mod 'puppetlabs/nodejs' 7 | mod 'smarchive/archive' 8 | mod 'rafaelfc/pear' 9 | mod 'adrien/alternatives' 10 | -------------------------------------------------------------------------------- /test/resources/checkers/go-testpackage/go-test-error_test.go: -------------------------------------------------------------------------------- 1 | // A simple import error in Go test file 2 | 3 | package testpackage 4 | 5 | import "testing" 6 | 7 | func TestFoo(t *testing.T) { 8 | fmt.Println("foo") 9 | } 10 | -------------------------------------------------------------------------------- /test/resources/checkers/erlang-error.erl: -------------------------------------------------------------------------------- 1 | %% Test an error from Erlang 2 | -module('erlang-error'). 3 | -compile(export_all). 4 | 5 | great_func() -> 6 | io:format("Flycheck is great!"); 7 | error_func() -> 8 | 'head-mismatch'. 9 | -------------------------------------------------------------------------------- /test/resources/checkers/puppet-lint-warning.pp: -------------------------------------------------------------------------------- 1 | # "case statement without a default case" 2 | case $::operatingsystem { 3 | debian: { 4 | $version = '1.2.3' 5 | } 6 | redhat: { 7 | $version = '6.6.6' 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /test/resources/checkers/tex-lacheck-warning.tex: -------------------------------------------------------------------------------- 1 | % Trigger a warning about a missing space 2 | % 3 | % Checkers: Chktex 4 | 5 | \documentclass{article} 6 | 7 | \begin{document} 8 | 9 | \foo{ 10 | } 11 | 12 | \end{document} 13 | -------------------------------------------------------------------------------- /test/resources/checkers/html-tidy-warning-and-error.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Hello world 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /test/resources/checkers/php-syntax-error.php: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/resources/checkers/python-flake8-warning-naming.py: -------------------------------------------------------------------------------- 1 | # Using non PEP8 compliant name 2 | # 3 | # Checkers: Flake8 with pep8-naming plug-in 4 | 5 | 6 | class myclass(object): 7 | def MyFunction(): 8 | X = 12 9 | return X 10 | -------------------------------------------------------------------------------- /test/resources/checkers/tex-chktex-warning.tex: -------------------------------------------------------------------------------- 1 | % Trigger a warning about an intersentence spacing 2 | % 3 | % Checkers: Chktex 4 | 5 | \documentclass{article} 6 | 7 | \begin{document} 8 | 9 | Hello, Emacs is part of GNU. Do you like it? 10 | 11 | \end{document} 12 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/go.pp: -------------------------------------------------------------------------------- 1 | # Go syntax checkers 2 | 3 | class flycheck::checkers::go { 4 | apt::ppa { 'ppa:gophers/go': } 5 | 6 | package { 'golang-stable': 7 | ensure => latest, 8 | require => Apt::Ppa['ppa:gophers/go'], 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /test/resources/checkers/c_c++-cppcheck-multiple-checks.cpp: -------------------------------------------------------------------------------- 1 | class A { 2 | A::~A(); 3 | }; 4 | 5 | typedef std::vector IntVec; 6 | void f(const IntVec& v) 7 | { 8 | int unused; 9 | for (IntVec::const_iterator it = v.begin(); it != v.end(); it++) { } 10 | } 11 | -------------------------------------------------------------------------------- /puppet/bootstrap.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | cd /tmp 4 | if ! dpkg -l | grep -q puppetlabs-release; then 5 | wget http://apt.puppetlabs.com/puppetlabs-release-precise.deb 6 | sudo dpkg -i puppetlabs-release-precise.deb 7 | fi 8 | 9 | sudo apt-get update -yy 10 | sudo apt-get install -y puppet 11 | -------------------------------------------------------------------------------- /test/resources/checkers/puppet-parser-multiline.pp: -------------------------------------------------------------------------------- 1 | # Test multi-line error messages. 2 | # 3 | # Error: Could not parse for environment production: Unclosed quote after '' in 'something 4 | # } 5 | # ' at parser_err3.pp:2 6 | # 7 | class {'parser_err3': 8 | hello => 'something 9 | } 10 | -------------------------------------------------------------------------------- /.dir-locals.el: -------------------------------------------------------------------------------- 1 | ;;; Directory Local Variables 2 | ;;; For more information see (info "(emacs) Directory Variables") 3 | 4 | ((emacs-lisp-mode 5 | (flycheck-emacs-lisp-initialize-packages . t) 6 | (eval . (setq flycheck-emacs-lisp-package-user-dir 7 | (expand-file-name (format ".cask/%s/elpa" emacs-version)))))) 8 | -------------------------------------------------------------------------------- /test/resources/checkers/python-flake8-warning-maximum-complexity.py: -------------------------------------------------------------------------------- 1 | # Trigger a McCabe complexity warning 2 | 3 | import sys 4 | 5 | 6 | def foo(spam=None): 7 | if spam: 8 | if sys.python_version[0] > 3: 9 | print('yes') 10 | else: 11 | print('no') 12 | else: 13 | return 'foo' 14 | -------------------------------------------------------------------------------- /test/resources/many-errors-for-error-list.el: -------------------------------------------------------------------------------- 1 | ;;; many-errors-for-error-list.el --- Trigger many errors for error list tests 2 | 3 | ;;; Commentary: 4 | 5 | ;; A file with many errors to test the error list 6 | 7 | (message "Hello %s") 8 | 9 | (princ) 10 | 11 | (i-do-not-exist) 12 | 13 | ;;; many-errors-for-error-list.el ends here 14 | -------------------------------------------------------------------------------- /test/resources/many-errors-for-navigation.el: -------------------------------------------------------------------------------- 1 | ;;; many-errors-for-navigation.el --- Trigger many errors for navigation tests 2 | 3 | ;;; Commentary: 4 | 5 | ;; A file with many errors to test error navigation. 6 | 7 | (message "Hello %s") 8 | 9 | (princ) 10 | 11 | (i-do-not-exist) 12 | 13 | ;;; many-errors-for-navigation.el ends here 14 | -------------------------------------------------------------------------------- /test/resources/chained-errors.el: -------------------------------------------------------------------------------- 1 | ;;; chained-errors.el --- A file with errors from two chained checkers 2 | 3 | ;;; Commentary: 4 | 5 | ;; A file with errors from two chained checkers to test that chaining preserves 6 | ;; all errors. 7 | 8 | (message "Hello %s") 9 | 10 | (princ) 11 | 12 | (i-do-not-exist) 13 | 14 | ;;; chained-errors.el ends here 15 | -------------------------------------------------------------------------------- /test/resources/checkers/elixir-warnings.ex: -------------------------------------------------------------------------------- 1 | # Warnings from Elixir 2 | 3 | defmodule Shadowed do 4 | def func() do 5 | a = 1 6 | fn(^a) -> a end 7 | end 8 | end 9 | 10 | defmodule AlwaysMatch do 11 | def func(_) do 12 | IO.puts "Flycheck is great!" 13 | end 14 | def func(:atom) do 15 | IO.puts "Cannot get here." 16 | end 17 | end 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | 3 | # Packages installed for development 4 | /.cask/ 5 | 6 | # Generated package archive 7 | /flycheck-pkg.el 8 | /flycheck-*.tar 9 | 10 | # Vagrant cache 11 | /.vagrant 12 | 13 | # Librarian Puppet cache and modules 14 | /.tmp/ 15 | /puppet/lib 16 | 17 | # Info documentation 18 | /doc/flycheck.info 19 | /doc/dir 20 | 21 | # HTML documentation 22 | /doc/html/ -------------------------------------------------------------------------------- /test/resources/narrowing.el: -------------------------------------------------------------------------------- 1 | ;;; narrowing.el --- Trigger errors with narrowing 2 | 3 | ;;; Commentary: 4 | 5 | ;; A file to test narrowing 6 | 7 | ;;; Code: 8 | 9 | (message "We are before of narrowing here: %s") 10 | 11 | (defun we-narrow-to-this-function () 12 | "This docstring has no final period" 13 | (message "Hello %s")) 14 | 15 | (message "We are after of narrowing here: %s") 16 | 17 | ;;; narrowing.el ends here 18 | -------------------------------------------------------------------------------- /test/.dir-locals.el: -------------------------------------------------------------------------------- 1 | ;;; Directory Local Variables 2 | ;;; For more information see (info "(emacs) Directory Variables") 3 | 4 | ((emacs-lisp-mode 5 | (flycheck-emacs-lisp-initialize-packages . t) 6 | (eval . (setq flycheck-emacs-lisp-package-user-dir 7 | (expand-file-name (format "../.cask/%s/elpa" emacs-version)) 8 | flycheck-emacs-lisp-load-path 9 | (list (expand-file-name "..")))))) 10 | -------------------------------------------------------------------------------- /test/resources/checkers/php-phpcs-error.php: -------------------------------------------------------------------------------- 1 | 15 | * @license http://www.gnu.org/licenses/gpl.html GPL-3 16 | * @link https://github.com/lunaryorn/flycheck 17 | */ 18 | 19 | $foo = FALSE; 20 | 21 | ?> -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | Vagrant.configure('2') do |config| 5 | config.vm.box = 'precise64' 6 | config.vm.box_url = 'http://files.vagrantup.com/precise64.box' 7 | 8 | config.vm.synced_folder '.', '/flycheck' 9 | 10 | config.vm.provision :shell, :path => 'puppet/bootstrap.sh' 11 | 12 | config.vm.provision :puppet do |puppet| 13 | puppet.manifests_path = 'puppet/manifests' 14 | puppet.manifest_file = 'site.pp' 15 | puppet.module_path = ['puppet/lib', 'puppet/modules'] 16 | end 17 | 18 | end 19 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/php.pp: -------------------------------------------------------------------------------- 1 | # Install PHP and PHP syntax checkers 2 | 3 | class flycheck::checkers::php { 4 | apt::ppa { 'ppa:ondrej/php5': } 5 | 6 | package { 'php5-cli': 7 | ensure => latest, 8 | require => Apt::Ppa['ppa:ondrej/php5'] 9 | } 10 | 11 | package { 'php-pear': 12 | ensure => latest, 13 | require => Package['php5-cli'], 14 | } 15 | 16 | package { 'PHP_CodeSniffer': # php-phpcs 17 | ensure => latest, 18 | provider => pear, 19 | require => Package['php-pear'], 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /Puppetfile.lock: -------------------------------------------------------------------------------- 1 | FORGE 2 | remote: http://forge.puppetlabs.com 3 | specs: 4 | adrien/alternatives (0.1.1) 5 | puppetlabs/apt (1.2.0) 6 | puppetlabs/stdlib (>= 2.2.1) 7 | puppetlabs/nodejs (0.3.0) 8 | puppetlabs/apt (>= 0.0.3) 9 | puppetlabs/stdlib (>= 2.0.0) 10 | puppetlabs/stdlib (4.1.0) 11 | rafaelfc/pear (1.0.3) 12 | smarchive/archive (0.1.1) 13 | 14 | DEPENDENCIES 15 | adrien/alternatives (>= 0) 16 | puppetlabs/apt (>= 0) 17 | puppetlabs/nodejs (>= 0) 18 | rafaelfc/pear (>= 0) 19 | smarchive/archive (>= 0) 20 | 21 | -------------------------------------------------------------------------------- /test/resources/checkers/emacs-lisp-checkdoc-warning.el: -------------------------------------------------------------------------------- 1 | ;;; emacs-lisp-checkdoc-warning.el -- Trigger checkdoc warning -*- lexical-binding: t; -*- 2 | 3 | ;;; Commentary: 4 | 5 | ;; Trigger a checkdoc warning by omitting a period in the docstring of a 6 | ;; function. All these comments are to make checkdoc happy, which also checks 7 | ;; the general commenting style of an Emacs Lisp file. 8 | 9 | ;;; Code: 10 | 11 | (defun foobar () 12 | "Does nothing really useful") 13 | 14 | ;; The following is also to make checkdoc happy. 15 | (provide 'missing-period-in-docstring) 16 | 17 | ;;; emacs-lisp-checkdoc-warning.el ends here 18 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/gems.pp: -------------------------------------------------------------------------------- 1 | # All our Rubygems 2 | 3 | class flycheck::checkers::gems { 4 | 5 | # We keep all gems in a separate class to install them separately on Travis 6 | # CI, as normal user, and not as root. If we install Gems as root on Travis, 7 | # RVM screws up, and won't find our gems. 8 | 9 | $gem_packages = [ 'haml', 10 | 'puppet-lint', 11 | 'rubocop', # ruby-rubocop 12 | 'sass', # sass/scss 13 | ] 14 | 15 | package { $gem_packages: 16 | ensure => installed, 17 | provider => gem, 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /puppet/modules/README.md: -------------------------------------------------------------------------------- 1 | Puppet manifests 2 | ================ 3 | 4 | This directory contains Puppet modules and manifests to provision our virtual 5 | machine for testing. These are split into the following directories: 6 | 7 | - `manifests/`: The root manifests. `travis.pp` is a 8 | special manifest solely for Travis CI, which is used to install Ruby Gems as 9 | normal user. 10 | - `lib/`: External Puppet modules. See `Puppetfile` for the required modules, 11 | and use `librarian-puppet install` to install these modules. Use `gem install 12 | librarian-puppet` to install the tool first. 13 | - `modules/`: Our own modules to provision the VM. 14 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/ruby.pp: -------------------------------------------------------------------------------- 1 | # Ruby syntax checkers 2 | 3 | class flycheck::checkers::ruby { 4 | package { ['ruby1.9.1', 'jruby']: 5 | ensure => latest, 6 | } 7 | 8 | # Make Ruby 1.9 the default Ruby 9 | alternatives { 'ruby': 10 | path => '/usr/bin/ruby1.9.1', 11 | require => Package['ruby1.9.1'], 12 | } 13 | 14 | # Make sure, Ruby is installed and configured before installing any Gems 15 | Alternatives['ruby'] -> Package<| provider == gem |> 16 | 17 | # Do not install Gems on Travis 18 | if $::travis { 19 | notice('Skipping Ruby Gems on Travis CI') 20 | } 21 | else { 22 | include flycheck::checkers::gems 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /test/resources/dummy-elpa/dummy-package-0.1/dummy-package-autoloads.el: -------------------------------------------------------------------------------- 1 | ;;; dummy-package-autoloads.el --- automatically extracted autoloads 2 | ;; 3 | ;;; Code: 4 | 5 | 6 | ;;;### (autoloads nil "dummy-package" "dummy-package.el" (20978 39905 7 | ;;;;;; 0 0)) 8 | ;;; Generated autoloads from dummy-package.el 9 | 10 | (autoload 'dummy-package-foo "dummy-package" "\ 11 | 12 | 13 | \(fn)" nil nil) 14 | 15 | ;;;*** 16 | 17 | ;;;### (autoloads nil nil ("dummy-package-pkg.el") (20978 39909 438930 18 | ;;;;;; 0)) 19 | 20 | ;;;*** 21 | 22 | (provide 'dummy-package-autoloads) 23 | ;; Local Variables: 24 | ;; version-control: never 25 | ;; no-byte-compile: t 26 | ;; no-update-autoloads: t 27 | ;; coding: utf-8 28 | ;; End: 29 | ;;; dummy-package-autoloads.el ends here 30 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/haskell.pp: -------------------------------------------------------------------------------- 1 | # Provide Haskell syntax checkers 2 | 3 | class flycheck::checkers::haskell { 4 | 5 | package { ['ghc', 'hlint']: ensure => latest } 6 | 7 | package { ['cabal-install']: 8 | ensure => latest, 9 | require => Package['ghc'], 10 | notify => Exec['cabal update'], 11 | } 12 | 13 | exec { 'cabal update': 14 | command => '/usr/bin/cabal update', 15 | refreshonly => true, 16 | environment => 'HOME=/root', 17 | require => Package['cabal-install'] 18 | } 19 | 20 | exec { 'hdevtools': 21 | command => '/usr/bin/cabal install --global hdevtools', 22 | creates => '/usr/local/bin/hdevtools', 23 | environment => 'HOME=/root', 24 | require => Exec['cabal update'], 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: emacs-lisp 2 | env: 3 | - EMACS=emacs24 4 | - EMACS=emacs-snapshot 5 | # Bootstrap Puppet, and install our Puppet modules 6 | before_install: 7 | - sh ./puppet/bootstrap.sh 8 | - gem install puppet librarian-puppet 9 | - librarian-puppet install 10 | # Call Puppet to bootstrap the testing environment and install test 11 | # requirements. We install Ruby tools separately as non-root user to avoid 12 | # screwing up with RVM. We pass --debug to prevent Travis from getting stuck 13 | # due to no output, and to get as good error messages as possible 14 | install: 15 | - sudo FACTER_travis=true puppet apply --debug --modulepath=./puppet/lib:./puppet/modules ./puppet/manifests/site.pp 16 | - puppet apply --debug --modulepath=./puppet/lib:./puppet/modules ./puppet/manifests/travis.pp 17 | - make packages 18 | # Build documentation and run unit tests 19 | script: 20 | - make -k info test 21 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/nodejs.pp: -------------------------------------------------------------------------------- 1 | # Node.js and Javascript checkers 2 | 3 | class flycheck::checkers::nodejs { 4 | 5 | # Install Node.js. We do not use the nodejs class, because it's broken on 6 | # Precise. It doesn't enable the PPA, and attempts to install NPM. 7 | apt::ppa { 'ppa:chris-lea/node.js': } 8 | 9 | package { 'nodejs': 10 | ensure => installed, 11 | require => Apt::Ppa['ppa:chris-lea/node.js'], 12 | } 13 | 14 | $node_packages = ['coffee-script', # coffee 15 | 'coffeelint', # coffee-coffeelint 16 | 'csslint', # css-csslint 17 | 'jshint', # javascript-jshint 18 | 'jsonlint', # json-jsonlint 19 | 'less', # less 20 | ] 21 | 22 | package { $node_packages: 23 | ensure => present, 24 | provider => npm, 25 | require => Package['nodejs'], 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /test/resources/checkers/config-files/coffeelint.json: -------------------------------------------------------------------------------- 1 | { 2 | "no_tabs" : { 3 | "level" : "error" 4 | }, 5 | 6 | "no_trailing_whitespace" : { 7 | "level" : "error" 8 | }, 9 | 10 | "max_line_length" : { 11 | "value": 80, 12 | "level" : "error" 13 | }, 14 | 15 | "camel_case_classes" : { 16 | "level" : "error" 17 | }, 18 | 19 | "indentation" : { 20 | "value" : 2, 21 | "level" : "error" 22 | }, 23 | 24 | "no_implicit_braces" : { 25 | "level" : "ignore" 26 | }, 27 | 28 | "no_trailing_semicolons" : { 29 | "level" : "error" 30 | }, 31 | 32 | "no_plusplus" : { 33 | "level" : "ignore" 34 | }, 35 | 36 | "no_throwing_strings" : { 37 | "level" : "warn" 38 | }, 39 | 40 | "cyclomatic_complexity" : { 41 | "value" : 11, 42 | "level" : "ignore" 43 | }, 44 | 45 | "line_endings" : { 46 | "value" : "unix", 47 | "level" : "ignore" 48 | }, 49 | 50 | "no_implicit_parens" : { 51 | "level" : "ignore" 52 | }, 53 | 54 | "no_stand_alone_at" : { 55 | "level": "ignore" 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (package-file "flycheck.el") 5 | 6 | (development 7 | ;; Make optional dependencies available for development 8 | (depends-on "google-this") 9 | 10 | (depends-on "ert") ; Unit test library 11 | (depends-on "ert-runner") ; Unit test runner 12 | (depends-on "mocker") ; Mocking library 13 | 14 | (depends-on "projectile") ; Projectile integration 15 | 16 | ;; Various modes for use in the unit tests 17 | (depends-on "coffee-mode") 18 | (depends-on "haml-mode") 19 | (depends-on "haskell-mode") 20 | (depends-on "web-mode") 21 | (depends-on "js2-mode") 22 | (depends-on "js3-mode") 23 | (depends-on "less-css-mode") 24 | (depends-on "lua-mode") 25 | (depends-on "cperl-mode") 26 | (depends-on "php-mode") 27 | (depends-on "puppet-mode") 28 | (depends-on "sass-mode") 29 | (depends-on "scala-mode2") 30 | (depends-on "scss-mode") 31 | (depends-on "go-mode") 32 | (depends-on "rust-mode") 33 | (depends-on "elixir-mode") 34 | (depends-on "erlang") 35 | (depends-on "d-mode")) 36 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/base.pp: -------------------------------------------------------------------------------- 1 | # Basic system setup 2 | 3 | class flycheck::base { 4 | include apt 5 | 6 | package { 'make': ensure => latest } 7 | 8 | # Required to add PPAs 9 | package { 'python-software-properties': ensure => latest } 10 | 11 | # Archive tools to extract Carton and syntax checker archives 12 | package { ['tar', 'unzip']: ensure => latest } 13 | 14 | # Texinfo building 15 | package { ['texinfo', 'install-info']: ensure => latest } 16 | 17 | # Emacs packages 18 | apt::ppa { 'ppa:cassou/emacs': } 19 | 20 | package { ['emacs24-nox', 'emacs-snapshot-nox']: 21 | ensure => latest, 22 | require => Apt::Ppa['ppa:cassou/emacs'] 23 | } 24 | 25 | $cask_version = '0.4.4' 26 | $cask_archive = "cask.el-${cask_version}" 27 | 28 | archive { $cask_archive: 29 | ensure => present, 30 | url => "https://github.com/rejeep/cask.el/archive/v${cask_version}.tar.gz", 31 | digest_string => 'df9ea7b05a260980ae42e8b8626e73ac', 32 | target => '/opt/' 33 | } 34 | 35 | file { '/usr/local/bin/cask': 36 | ensure => link, 37 | target => "/opt/${cask_archive}/bin/cask", 38 | require => Archive["cask.el-${cask_version}"], 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/erlang.pp: -------------------------------------------------------------------------------- 1 | # Install Erlang and related checkers 2 | 3 | class flycheck::checkers::erlang { 4 | apt::source { 'erlang-solutions': 5 | location => 'http://binaries.erlang-solutions.com/debian', 6 | repos => 'contrib', 7 | key => 'A14F4FCA', 8 | key_source => 'http://binaries.erlang-solutions.com/debian/erlang_solutions.asc', 9 | include_src => false, 10 | } 11 | 12 | package { 'esl-erlang': 13 | ensure => installed, 14 | require => Apt::Source['erlang-solutions'] 15 | } 16 | 17 | $elixir_version = '0.10.0' 18 | 19 | archive { "elixir-${elixir_version}": 20 | ensure => present, 21 | url => "https://github.com/elixir-lang/elixir/releases/download/v${elixir_version}/v${elixir_version}.zip", 22 | extension => 'zip', 23 | digest_string => '8a7611ffb39292d8a43f479e55afdbf3', 24 | target => "/opt/elixir-${elixir_version}", 25 | root_dir => ".", 26 | require => Package['esl-erlang'], 27 | } 28 | 29 | file { '/usr/local/bin/elixirc': 30 | ensure => link, 31 | target => "/opt/elixir-${elixir_version}/bin/elixirc", 32 | require => Archive["elixir-${elixir_version}"], 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /doc/flycheck.css: -------------------------------------------------------------------------------- 1 | body { 2 | font-family: "HelveticaNeue-Light","Helvetica Neue Light","Helvetica Neue",Helvetica,Arial,sans-serif; 3 | font-size: 11pt; 4 | background: #eee; 5 | color: #666; 6 | line-height: 2; 7 | padding: 30px 0; 8 | margin: 0 auto; 9 | max-width: 1000px; 10 | } 11 | 12 | @media screen and (max-width: 800px) { 13 | body { 14 | margin: 0 15px; 15 | } 16 | } 17 | 18 | a { 19 | text-decoration: none; 20 | color: #258fb8; 21 | } 22 | 23 | p { 24 | margin: 1em 0; 25 | display: block; 26 | } 27 | 28 | h1 { 29 | margin-top: 10px; 30 | font-size: 1.8em; 31 | } 32 | 33 | h2 { 34 | font-size: 1.5em; 35 | } 36 | 37 | h3 { 38 | font-size: 1.3em; 39 | } 40 | 41 | samp, code, kbd { 42 | background: #ddd; 43 | border: 1px solid #ccc; 44 | font-family: Menlo,Monaco,"Andale Mono","lucida console","Courier New",monospace; 45 | font-size: 0.9em; 46 | padding: 1px 3px; 47 | margin: 0 3px; 48 | border-radius: 5px; 49 | font-style: normal; 50 | } 51 | 52 | pre { 53 | background: #ddd; 54 | border: 1px solid #ccc; 55 | font-family: Menlo,Monaco,"Andale Mono","lucida console","Courier New",monospace; 56 | font-size: 0.9em; 57 | padding: 1px 3px; 58 | margin: 0 3px; 59 | border-radius: 5px; 60 | font-style: normal; 61 | overflow-x: auto; 62 | line-height: 1.5; 63 | } 64 | 65 | #frontmatter { 66 | width: 700px; 67 | margin: 0 auto; 68 | } 69 | 70 | #frontmatter div { 71 | display: block; 72 | margin: 1em 0; 73 | } -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers/python.pp: -------------------------------------------------------------------------------- 1 | # Syntax checkers for Python 2 | 3 | class flycheck::checkers::python { 4 | package { ['python', 'python-setuptools'] : ensure => latest } 5 | 6 | # Bootstrap a decent Pip release 7 | $pip = 'pip-1.4.1' 8 | $pip_archive = "${pip}.tar.gz" 9 | 10 | archive { $pip_archive: 11 | ensure => present, 12 | url => "https://pypi.python.org/packages/source/p/pip/${pip_archive}", 13 | digest_string => '6afbb46aeb48abac658d4df742bff714', 14 | target => '/usr/src', 15 | } 16 | 17 | exec { 'flycheck::checkers::python::bootstrap-pip': 18 | command => '/usr/bin/python setup.py install', 19 | cwd => "/usr/src/${pip}", 20 | creates => '/usr/local/bin/pip', 21 | require => [Package['python-setuptools'], Archive[$pip_archive]], 22 | } 23 | 24 | # Now upgrade to the latest version of setuptools and pip 25 | package { 'setuptools': 26 | ensure => latest, 27 | provider => pip, 28 | require => Exec['flycheck::checkers::python::bootstrap-pip'], 29 | } 30 | 31 | package { 'pip': 32 | ensure => latest, 33 | provider => pip, 34 | require => Package['setuptools'], 35 | } 36 | 37 | $python_packages = ['flake8', # python-flake8 38 | 'pep8-naming', # Plugin for flake8 39 | 'pylint', # python-pylint 40 | 'docutils', # rst 41 | ] 42 | 43 | package { $python_packages: 44 | ensure => latest, 45 | provider => pip, 46 | require => Package['pip'], 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Contributing 2 | ============ 3 | 4 | If you discovered bugs and issues, have ideas for improvements or new features, 5 | or want to contribute a new syntax checker, please report to the 6 | [issue tracker][1] the repository and send a pull request, but respect the 7 | following guidelines. 8 | 9 | 10 | Issue reporting 11 | --------------- 12 | 13 | - Check that the issue has not already been reported. 14 | - Check that the issue has not already been fixed in the latest code. 15 | - Be clear and precise (do not prose, but name functions and commands exactly). 16 | - Open an issue with a clear title and description in grammatically correct, 17 | complete sentences. 18 | 19 | 20 | Pull requests 21 | ------------- 22 | 23 | - Read [how to properly contribute to open source projects on Github][2]. 24 | - Use a topic branch to easily amend a pull request later, if necessary. 25 | - Write [good commit messages][3]. 26 | - Use the same coding style and spacing. 27 | - Verify your Emacs Lisp code with `checkdoc` (`C-c ? d`). 28 | - Add unit tests for your new checkers. Take a look at existing tests, and do 29 | not forget to update `vagrant/provision.py` to install your checker tool into 30 | the virtual testing environment. 31 | - Open a [pull request][4] that relates to but one subject with a clear title 32 | and description in grammatically correct, complete sentences. 33 | 34 | 35 | [1]: https://github.com/lunaryorn/flycheck/issues 36 | [2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request 37 | [3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html 38 | [4]: https://help.github.com/articles/using-pull-requests 39 | -------------------------------------------------------------------------------- /puppet/modules/flycheck/manifests/checkers.pp: -------------------------------------------------------------------------------- 1 | # Install all syntax checkers 2 | 3 | class flycheck::checkers { 4 | 5 | include flycheck::checkers::erlang 6 | include flycheck::checkers::go 7 | include flycheck::checkers::haskell 8 | include flycheck::checkers::nodejs 9 | include flycheck::checkers::php 10 | include flycheck::checkers::python 11 | include flycheck::checkers::ruby 12 | 13 | # Various other syntax checkers 14 | 15 | apt::ppa { 'ppa:kevincantu/rust': } 16 | 17 | package { 'rust': 18 | ensure => latest, 19 | require => Apt::Ppa['ppa:kevincantu/rust'] 20 | } 21 | 22 | $packages = [ 'bash', # bash/sh-bash 23 | 'clang', # c/c++-clang 24 | 'cppcheck', # c/c++-cpppcheck 25 | 'tidy', # html-tidy 26 | 'lua5.2', # lua 27 | 'perl', # perl 28 | 'puppet', # puppet-parser 29 | 'scala', # scala 30 | 'dash', # sh-dash 31 | 'chktex', # tex-chktex 32 | 'lacheck', # tex-lacheck 33 | 'xmlstarlet', # xml-xmlstarlet 34 | 'libxml2-utils', # xml-xmllint 35 | 'zsh', # zsh 36 | ] 37 | package { $packages: ensure => latest } 38 | 39 | $dmd_version = '2.063.2' 40 | $dmd_deb = "dmd_${dmd_version}-0_amd64.deb" 41 | 42 | archive::download { $dmd_deb: 43 | url => "http://downloads.dlang.org/releases/2013/${dmd_deb}", 44 | digest_string => 'fa2c04994df432156903fc66a4c73727', 45 | } 46 | 47 | # DMD dependencies need to be installed explicitly, as DPKG does not resolve 48 | # them 49 | package { ['gcc-multilib', 'xdg-utils']: 50 | ensure => latest, 51 | } 52 | 53 | package { 'dmd': 54 | ensure => present, 55 | provider => dpkg, 56 | source => "/usr/src/${dmd_deb}", 57 | require => [ Archive::Download[$dmd_deb], 58 | Package['gcc-multilib'], Package['xdg-utils'] ] 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS ?= emacs 2 | EMACSFLAGS = 3 | CASK = cask 4 | VAGRANT = vagrant 5 | INSTALL-INFO = install-info 6 | VERSION := $(shell EMACS=$(EMACS) $(CASK) version) 7 | PKGDIR := $(shell EMACS=$(EMACS) $(CASK) package-directory) 8 | 9 | # Export the used EMACS to recipe environments 10 | export EMACS 11 | 12 | SRCS = flycheck.el 13 | OBJECTS = $(SRCS:.el=.elc) 14 | 15 | DOC_SRCS = doc/api.texi \ 16 | doc/changes.texi \ 17 | doc/checkers.texi \ 18 | doc/contribution.texi \ 19 | doc/credits.texi \ 20 | doc/extending.texi \ 21 | doc/fdl-1.3.texi \ 22 | doc/flycheck.texi \ 23 | doc/github-ribbon.texi \ 24 | doc/html-frontmatter.texi \ 25 | doc/introduction.texi \ 26 | doc/usage.texi 27 | HTML_SRCS = $(DOC_SRCS) doc/htmlxref.cnf 28 | HTML_TARGETS = doc/html/index.html \ 29 | doc/html/screenshot.png \ 30 | doc/html/flycheck.css 31 | 32 | 33 | PACKAGE_SRCS = $(SRCS) \ 34 | flycheck-pkg.el \ 35 | doc/flycheck.info doc/dir 36 | PACKAGE = flycheck-$(VERSION).tar 37 | 38 | .PHONY: compile 39 | compile : $(OBJECTS) 40 | 41 | .PHONY: package 42 | package : $(PACKAGE) 43 | 44 | $(PACKAGE) : $(PACKAGE_SRCS) 45 | rm -rf flycheck-$(VERSION) 46 | mkdir -p flycheck-$(VERSION) 47 | cp -f $(PACKAGE_SRCS) flycheck-$(VERSION) 48 | tar cf $(PACKAGE) flycheck-$(VERSION) 49 | rm -rf flycheck-$(VERSION) 50 | 51 | .PHONY: clean-all 52 | clean-all : clean clean-pkgdir clean-doc 53 | 54 | .PHONY: clean 55 | clean : 56 | rm -f $(OBJECTS) 57 | rm -rf flycheck-*.tar flycheck-pkg.el 58 | 59 | .PHONY: packages 60 | packages : $(PKGDIR) 61 | 62 | .PHONY: clean-pkgdir 63 | clean-pkgdir : 64 | rm -rf $(PKGDIR) 65 | 66 | .PHONY: test 67 | test : compile 68 | $(CASK) exec ert-runner 69 | 70 | .PHONY: vagrant-test 71 | vagrant-test : 72 | $(VAGRANT) up 73 | $(VAGRANT) ssh -c "make -C /flycheck EMACS=$(EMACS) clean test" 74 | 75 | .PHONY: doc 76 | doc : info html 77 | 78 | .PHONY: clean-doc 79 | clean-doc : clean-info clean-html 80 | 81 | .PHONY: info 82 | info: doc/dir 83 | 84 | .PHONY: clean-info 85 | clean-info : 86 | rm -f doc/flycheck.info doc/dir 87 | 88 | .PHONY: html 89 | html : $(HTML_TARGETS) 90 | 91 | .PHONY: clean-html 92 | clean-html: 93 | rm -rf doc/html 94 | 95 | %.elc : %.el $(PKGDIR) 96 | $(CASK) exec $(EMACS) -Q --batch $(EMACSFLAGS) -f batch-byte-compile $< 97 | 98 | $(PKGDIR) : Cask 99 | $(CASK) install 100 | touch $(PKGDIR) 101 | 102 | flycheck-pkg.el : Cask 103 | $(CASK) package 104 | 105 | doc/dir : doc/flycheck.info 106 | $(INSTALL-INFO) doc/flycheck.info doc/dir 107 | 108 | doc/flycheck.info : $(DOC_SRCS) 109 | 110 | doc/html/screenshot.png : doc/screenshot.png 111 | cp -f $< $@ 112 | 113 | doc/html/flycheck.css : doc/flycheck.css 114 | cp -f $< $@ 115 | 116 | doc/html/index.html: $(DOC_SRCS) 117 | $(MAKEINFO) --html --split=chapter --css-ref=flycheck.css -o doc/html doc/flycheck.texi 118 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Flycheck [![Build Status](https://travis-ci.org/lunaryorn/flycheck.png?branch=master)](https://travis-ci.org/lunaryorn/flycheck) 2 | ======== 3 | 4 | Flycheck (aka “Flymake done right”) is a modern on-the-fly syntax checking 5 | extension for GNU Emacs 24 with: 6 | 7 | - ready-to-use syntax checkers for a bunch of languages, 8 | - easy customization, 9 | - a comprehensive manual, 10 | - a dead simple, declarative API to create new syntax checkers, 11 | - major-mode based selection of syntax checkers, 12 | - multiple syntax checkers per buffer, 13 | - optional error list popup, 14 | - a “doesn’t get in your way” guarantee, 15 | - and a clean, concise and understandable implementation with decent test 16 | coverage. 17 | 18 | ![Screenshot of Flycheck in action](https://github.com/lunaryorn/flycheck/raw/master/doc/screenshot.png) 19 | 20 | The screenshot was taken on Emacs 24.3 using the awesome 21 | [solarized-light][solarized] color theme and the great 22 | [Anonymous Pro](http://www.marksimonson.com/fonts/view/anonymous-pro) font. 23 | 24 | 25 | Features 26 | -------- 27 | 28 | - Automatic on-the-fly syntax checking while editing 29 | - Fully automatic selection of the best syntax checker 30 | - Optional manual selection of a syntax checker with `flycheck-select-checker` 31 | at `C-c ! s` 32 | - Built-in syntax checkers for: 33 | - C/C++ 34 | - CoffeeScript 35 | - CSS 36 | - D 37 | - Elixir 38 | - Emacs Lisp 39 | - Erlang 40 | - Go 41 | - Haml 42 | - Haskell 43 | - HTML 44 | - Javascript 45 | - JSON 46 | - LESS 47 | - Lua 48 | - Perl 49 | - PHP 50 | - Puppet 51 | - Python 52 | - Ruby 53 | - Rust 54 | - RST (ReStructuredText) 55 | - Sass 56 | - Scala 57 | - SCSS 58 | - Shell scripts (POSIX Shell, Bash and Zsh) 59 | - TeX/LaTeX 60 | - XML 61 | - Nice error indication and highlighting 62 | - Easy customization 63 | - Syntax checker configuration with project-specific configuration files and 64 | options 65 | - Error navigation with `next-error` and `previous-error` 66 | - Error list with `flycheck-list-errors` at `C-c ! l` 67 | - Declarative API to define new syntax checkers 68 | - Error parsers for structured markup formats (e.g. Checkdoc XML) 69 | 70 | ### 3rd party extensions 71 | 72 | The following extensions provide additional cool features for Flycheck: 73 | 74 | - [flycheck-color-mode-line.el][color-mode-line] colors the mode line according 75 | to the Flycheck status. 76 | - [flycheck-d-unittest][https://github.com/tom-tan/flycheck-d-unittest] adds a 77 | Flycheck checker to run unit tests for D programs on the fly. 78 | 79 | 80 | Installation 81 | ------------ 82 | 83 | Install the ELPA package from [MELPA](http://melpa.milkbox.net) or 84 | [Marmalade](http://marmalade-repo.org/) with `M-x package-install RET flycheck`. 85 | All dependencies are automatically installed. 86 | 87 | Flycheck supports GNU Emacs 24.2 and newer on Linux, OS X and any other decent 88 | flavor of Unix. It should work with GNU Emacs 24.1, too, but it is not tested 89 | against this version of Emacs. 90 | 91 | Flycheck does not support Windows, but tries to be compatible with it. You may 92 | try to use Flycheck on Windows. It should mostly work, but expect problems and 93 | issues. Pull requests which improve Windows compatibility are welcome. 94 | 95 | Flycheck also does not support GNU Emacs 23 and other flavors of Emacs 96 | (e.g. XEmacs, Aquamacs, etc.). Don't try, it will *not* work. 97 | 98 | Most checkers have dependencies against external tools that perform the 99 | checking. Use `C-c ! ?` to see what a checker needs, e.g. `C-c ! ? 100 | python-pylint`. 101 | 102 | 103 | Usage 104 | ----- 105 | 106 | Once installed, enable Flycheck mode with `M-x flycheck-mode`. 107 | 108 | To enable Flycheck mode in all buffers, in which it can be used, add the 109 | following to your `init.el` file: 110 | 111 | ```scheme 112 | (add-hook 'after-init-hook #'global-flycheck-mode) 113 | ``` 114 | 115 | In Flycheck mode the buffer will automatically be checked on the fly, if a 116 | suitable syntax checker exists. Use `C-c ! c` to start a syntax check manually. 117 | 118 | A suitable syntax checker is automatically selected from the list of registered 119 | checkers in `flycheck-checkers`. Use `C-c ! s` to manually select a specific 120 | syntax checker, or configure the syntax checker per file by setting 121 | `flycheck-checker` as file local variable:: 122 | 123 | ```python 124 | # Local Variables: 125 | # flycheck-checker: python-pylint 126 | # End: 127 | ``` 128 | 129 | Some syntax checkers read configuration files. Use `M-x customize-group RET 130 | flycheck-config-files` to customize these. Refer to the section *Configuration* 131 | in the Flycheck info manual. 132 | 133 | Errors and warnings from the syntax checker are reported in the mode line, 134 | highlighted in the buffer and indicated with icons in the fringe. Customize 135 | `flycheck-highlighting-mode` to change the highlighting of errors. 136 | 137 | **Note:** The default highlighting faces provided GNU Emacs are ill-suited to 138 | highlight errors. They are too easily overlooked. Make sure to customize these 139 | faces to add a striking background color or an underlying, or choose a color 140 | theme with reasonable Flycheck faces, for instance the excellent light or dark 141 | [solarized][] themes. 142 | 143 | Use `C-c ! n` and `C-c ! p` to navigate between errors. If the point is on an 144 | error, the error message is shown in the echo area or in a popup buffer after a 145 | short delay. You may also hover the mouse over a highlighted error to get a 146 | tooltip with the error message. 147 | 148 | Read the complete manual with `C-c ! i` or `M-x flycheck-info`. 149 | 150 | 151 | Credits 152 | ------- 153 | 154 | The following people contributed to flycheck: 155 | 156 | - [Bozhidar Batsov](https://github.com/bbatsov) provided valuable feedback and 157 | refinements, brought Flycheck to a larger user base by adding it to his 158 | awesome [Prelude](https://github.com/bbatsov/prelude) project, and added a 159 | Ruby syntax checker using `rubocop`. 160 | - [Damon Haley](https://github.com/dhaley) helped to shape and test the PHP 161 | CodeSniffer checker. 162 | - [David Holm](https://github.com/dholm) added C/C++ syntax and style checkers 163 | using `clang` and `cppcheck` respectively. 164 | - [Jimmy Yuen Ho Wong](https://github.com/wyuenho) added the HTML syntax checker 165 | and the jshint Javascript checker, and did valuable testing and bug fixing. 166 | - [Krzysztof Witkowski](https://github.com/kwitek) implemented `eval` support in 167 | Flycheck commands. 168 | - [Magnar Sveen](https://github.com/magnars) developed the awesome 169 | [dash.el](https://github.com/magnars/dash.el) and 170 | [s.el](https://github.com/magnars/s.el) libraries, that drive considerable 171 | parts of Flycheck's internals. 172 | - [Marian Schubert](https://github.com/maio) added the Perl syntax checker. 173 | - [Mark Hellewell](https://github.com/markhellewell) added the Puppet syntax and 174 | style checkers. 175 | - [Martin Grenfell](https://github.com/scrooloose) created the awesome Vim 176 | library [syntastic](https://github.com/scrooloose/syntastic) which inspired 177 | this project and many of its checkers. 178 | - [Matthias Dahl](https://github.com/Binarykhaos) improved the performance of 179 | Flycheck's temp file handling. 180 | - [Peter Vasil](https://github.com/ptrv) contributed syntax checkers for XML, 181 | Lua and Go (using `go build` and `go test`), added unit tests and did valuable 182 | testing. 183 | - [Robert Dallas Gray](https://github.com/rdallasgray) made error display 184 | customizable with `flycheck-display-errors-function`. 185 | - [Robert Zaremba](https://github.com/robert-zaremba) added a Go syntax checker 186 | using `gofmt`. 187 | - [steckerhalter](https://github.com/steckerhalter) provided the PHP CodeSniffer 188 | checker. 189 | - [Steve Purcell](https://github.com/purcell) implemented many checkers, 190 | contributed important ideas to the design of the checker API and engaged in 191 | worthwhile discussion to shape this project. 192 | - [Sylvain Benner](https://github.com/syl20bnr) added syntax checkers for Elixir 193 | and Erlang, and wrote the cool [flycheck-color-mode-line.el][color-mode-line] 194 | extension. 195 | - [Sylvain Rousseau](https://github.com/thisirs) added a syntax checker for 196 | POSIX shell script using `bash`, and improved error parsing in the Bash script 197 | syntax checker. 198 | - [tom tan](https://github.com/tom-tan) added a syntax checker for the D 199 | programming language using `dmd`. 200 | - [Yannick Roehlly](https://github.com/yannick1974) added support for PEP8 201 | naming errors to the Flake8 syntax checker. 202 | - [Victor Deryagin](https://github.com/vderyagin) added the Rust syntax checker. 203 | 204 | 205 | License 206 | ------- 207 | 208 | This program is free software: you can redistribute it and/or modify it under 209 | the terms of the GNU General Public License as published by the Free Software 210 | Foundation, either version 3 of the License, or (at your option) any later 211 | version. 212 | 213 | This program is distributed in the hope that it will be useful, but WITHOUT ANY 214 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 215 | PARTICULAR PURPOSE. See the GNU General Public License for more details. 216 | 217 | You should have received a copy of the GNU General Public License along with 218 | this program. If not, see http://www.gnu.org/licenses/. 219 | 220 | See [COPYING](https://github.com/lunaryorn/flycheck/blob/master/COPYING) for 221 | details. 222 | 223 | [solarized]: https://github.com/bbatsov/solarized-emacs 224 | [color-mode-line]: https://github.com/syl20bnr/flycheck-color-mode-line 225 | [dholm]: https://github.com/dholm 226 | -------------------------------------------------------------------------------- /test/test-helper.el: -------------------------------------------------------------------------------- 1 | ;;; test-helper.el --- Test helpers for Flycheck -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2013 Sebastian Wiesner 4 | 5 | ;; Author: Sebastian Wiesner 6 | ;; URL: https://github.com/lunaryorn/flycheck 7 | 8 | ;; This file is not part of GNU Emacs. 9 | 10 | ;; This program is free software: you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation, either version 3 of the License, or 13 | ;; (at your option) any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with this program. If not, see . 22 | 23 | ;;; Commentary: 24 | 25 | ;; Unit test helpers for Flycheck. 26 | 27 | ;; Test discovery and loading 28 | ;; -------------------------- 29 | ;; 30 | ;; Find and load all tests. 31 | ;; 32 | ;; Test files and directories must match the 33 | ;; `flycheck-testsuite-test-file-pattern'. Essentially this pattern matches all 34 | ;; directories and files starting with the prefix "test-". 35 | ;; 36 | ;; `flycheck-testsuite-load-tests' finds and loads all tests. 37 | 38 | ;; Resource handling 39 | ;; ----------------- 40 | ;; 41 | ;; These functions can be used to load resources within a test. 42 | ;; 43 | ;; `flycheck-testsuite-resource-filename' gets the file name of resources. 44 | ;; 45 | ;; `flycheck-testsuite-with-resource-buffer' executes forms with a temporary 46 | ;; buffer using a resource file from the test suite. 47 | 48 | ;; Test helpers 49 | ;; ------------ 50 | ;; 51 | ;; `flycheck-testsuite-with-hook' executes the body with a specified hook form. 52 | ;; 53 | ;; `flycheck-mode-no-check' enables Flycheck Mode in the current buffer without 54 | ;; starting a syntax check immediately. 55 | ;; 56 | ;; `flycheck-with-global-mode' enables Global Flycheck Mode while the body is 57 | ;; evaluated. 58 | ;; 59 | ;; `flycheck-testsuite-delete-temps' deletes Flycheck temporary files after the 60 | ;; body was evaluated. 61 | ;; 62 | ;; `flycheck-testsuite-with-help-buffer' kills the Help buffer after the body 63 | ;; was evaluated. 64 | ;; 65 | ;; `flycheck-testsuite-not-on-travis' signals an error if the test is run on 66 | ;; Travis CI. Use in combination with `:expected-result' to skip tests on 67 | ;; Travis CI. 68 | 69 | ;; Test environment utilities 70 | ;; -------------------------- 71 | ;; 72 | ;; `flycheck-testsuite-windows-p' determines whether the tests are running on 73 | ;; Windows. 74 | ;; 75 | ;; `flycheck-testsuite-min-emacs-version-p' determines whether Emacs has at 76 | ;; least the given version. 77 | ;; 78 | ;; `flycheck-testsuite-user-error-type' provides the type of `user-error', 79 | ;; depending on the Emacs version. 80 | 81 | ;; Test results 82 | ;; ------------ 83 | ;; 84 | ;; The following functions are intended for use with as value for the 85 | ;; `:expected-result' keyword to `ert-deftest'. 86 | ;; 87 | ;; `flycheck-testsuite-fail-unless-checkers' marks a test as expected to fail if 88 | ;; the given syntax checkers are not installed. 89 | 90 | ;; Checking buffers 91 | ;; ---------------- 92 | ;; 93 | ;; The following functions can be used to perform syntax checks in a test. 94 | ;; 95 | ;; `flycheck-testsuite-buffer-sync' starts a syntax check in the current buffer 96 | ;; and waits for the syntax check to complete. 97 | ;; 98 | ;; `flycheck-testsuite-wait-for-syntax-checker' waits until the syntax check in 99 | ;; the current buffer is finished. 100 | ;; 101 | ;; `flycheck-testsuite-disable-checkers' disables syntax checkers in the current 102 | ;; buffers. 103 | 104 | ;; Test predicates 105 | ;; --------------- 106 | ;; 107 | ;; `flycheck-testsuite-should-errors' tests that the current buffer has ERRORS. 108 | ;; 109 | ;; `flycheck-testsuite-should-syntax-check' tests that a syntax check results in 110 | ;; the specified errors. 111 | ;; 112 | ;; `flycheck-testsuite-ensure-clear' clear the error state of the current 113 | ;; buffer, and signals a test failure if clearing failed. 114 | 115 | ;;; Code: 116 | 117 | 118 | ;;;; Directories 119 | (require 'f) 120 | 121 | (eval-and-compile 122 | (defconst flycheck-testsuite-dir (f-parent (f-this-file)) 123 | "The testsuite directory.") 124 | 125 | (defconst flycheck-testsuite-resources-dir 126 | (f-join flycheck-testsuite-dir "resources") 127 | "Directory of test resources.")) 128 | 129 | 130 | ;;;; Requires 131 | 132 | (require 'flycheck (f-join flycheck-testsuite-dir "../flycheck")) 133 | (require 'ert) 134 | 135 | 136 | ;;;; Testsuite resource handling 137 | (defun flycheck-testsuite-resource-filename (resource-file) 138 | "Determine the absolute file name of a RESOURCE-FILE. 139 | 140 | Relative file names are expanded against 141 | `flycheck-testsuite-resource-dir'." 142 | (f-join flycheck-testsuite-resources-dir resource-file)) 143 | 144 | (defun flycheck-testsuite-locate-config-file (filename _checker) 145 | "Find a configuration FILENAME in the testsuite. 146 | 147 | _CHECKER is ignored." 148 | (let* ((directory (flycheck-testsuite-resource-filename "checkers/config-files")) 149 | (filepath (expand-file-name filename directory))) 150 | (when (f-exists? filepath) 151 | filepath))) 152 | 153 | (defmacro flycheck-testsuite-with-resource-buffer (resource-file &rest body) 154 | "Create a temp buffer from a RESOURCE-FILE and execute BODY. 155 | 156 | The absolute file name of RESOURCE-FILE is determined with 157 | `flycheck-testsuite-resource-filename'." 158 | (declare (indent 1)) 159 | `(let ((filename (flycheck-testsuite-resource-filename ,resource-file))) 160 | (should (f-exists? filename)) 161 | (with-temp-buffer 162 | (insert-file-contents filename t) 163 | (cd (f-parent filename)) 164 | (rename-buffer (f-filename filename)) 165 | ,@body))) 166 | 167 | 168 | ;;;; Test helpers 169 | (defmacro flycheck-testsuite-with-hook (hook-var form &rest body) 170 | "Set HOOK-VAR to FORM and evaluate BODY. 171 | 172 | HOOK-VAR is a hook variable or a list thereof, which is set to 173 | FORM before evaluating BODY. 174 | 175 | After evaluation of BODY, set HOOK-VAR to nil." 176 | (declare (indent 2)) 177 | `(let ((hooks (quote ,(if (listp hook-var) hook-var (list hook-var))))) 178 | (unwind-protect 179 | (progn 180 | (--each hooks (add-hook it #'(lambda () ,form))) 181 | ,@body) 182 | (--each hooks (set it nil))))) 183 | 184 | (defun flycheck-mode-no-check () 185 | "Enable Flycheck mode without checking automatically." 186 | (emacs-lisp-mode) 187 | (let ((flycheck-check-syntax-automatically nil)) 188 | (flycheck-mode)) 189 | (should-not (flycheck-deferred-check-p))) 190 | 191 | (defmacro flycheck-with-global-mode (&rest body) 192 | "Execute BODY with Global Flycheck Mode enabled." 193 | (declare (indent 0)) 194 | `(unwind-protect 195 | (progn 196 | (global-flycheck-mode 1) 197 | ,@body) 198 | (global-flycheck-mode -1))) 199 | 200 | (defmacro flycheck-testsuite-delete-temps (&rest body) 201 | "Execute BODY and delete Flycheck's temporary files." 202 | (declare (indent 0)) 203 | `(unwind-protect 204 | (progn ,@body) 205 | (flycheck-safe-delete-files flycheck-temp-files) 206 | (flycheck-safe-delete-directories flycheck-temp-directories) 207 | (setq flycheck-temp-files nil) 208 | (setq flycheck-temp-directories nil))) 209 | 210 | (defmacro flycheck-testsuite-trap-temp-dir (dirname &rest body) 211 | "Trap a temporary DIRNAME inside BODY." 212 | (declare (indent 1)) 213 | `(progn 214 | (flycheck-testsuite-delete-temps 215 | (should (equal flycheck-temp-directories (list ,dirname))) 216 | ,@body) 217 | (should-not (f-exists? dirname)))) 218 | 219 | (defmacro flycheck-testsuite-trap-temp-file (filename &rest body) 220 | "Trap a temporary FILENAME inside BODY." 221 | (declare (indent 1)) 222 | `(progn 223 | (flycheck-testsuite-delete-temps 224 | (should (equal flycheck-temp-files (list ,filename))) 225 | ,@body) 226 | (should-not (f-exists? filename)))) 227 | 228 | (defmacro flycheck-testsuite-with-help-buffer (&rest body) 229 | "Execute BODY and kill the help buffer afterwards." 230 | (declare (indent 0)) 231 | `(unwind-protect 232 | (progn ,@body) 233 | (when (buffer-live-p (get-buffer (help-buffer))) 234 | (kill-buffer (help-buffer))))) 235 | 236 | (defun flycheck-testsuite-not-on-travis () 237 | "Signal an error if run on Travis CI. 238 | 239 | Use together with `:expected-result' to skip tests on travis CI." 240 | (when (flycheck-testsuite-travis-ci-p) 241 | (error "Test skipped on Travis CI."))) 242 | 243 | 244 | ;;;; Test environment helpers 245 | (defun flycheck-testsuite-windows-p () 246 | "Determine whether the testsuite is running on Windows." 247 | (memq system-type '(ms-dos windows-nt cygwin))) 248 | 249 | (defun flycheck-testsuite-travis-ci-p () 250 | "Determine whether the testsuite is running on Travis CI." 251 | (string= (getenv "TRAVIS") "true")) 252 | 253 | (defun flycheck-testsuite-min-emacs-version-p (major &optional minor) 254 | "Determine whether Emacs has the required version. 255 | 256 | Return t if Emacs is at least MAJOR.MINOR, or nil otherwise." 257 | (when (>= emacs-major-version major) 258 | (or (null minor) (>= emacs-minor-version minor)))) 259 | 260 | (defconst flycheck-testsuite-user-error-type 261 | (if (flycheck-testsuite-min-emacs-version-p 24 3) 'user-error 'error) 262 | "The `user-error' type used by Flycheck.") 263 | 264 | 265 | ;;;; Test results 266 | (defun flycheck-testsuite-fail-unless-checkers (&rest checkers) 267 | "Skip the test unless all CHECKERS are present on the system. 268 | 269 | Return `:passed' if all CHECKERS are installed, or `:failed' otherwise." 270 | (if (-all? 'flycheck-check-executable checkers) 271 | :passed 272 | :failed)) 273 | 274 | (defalias 'flycheck-testsuite-fail-unless-checker 275 | 'flycheck-testsuite-fail-unless-checkers) 276 | 277 | 278 | ;;;; Checking buffers 279 | (defvar-local flycheck-testsuite-syntax-checker-finished nil 280 | "Non-nil if the current checker has finished.") 281 | 282 | (add-hook 'flycheck-after-syntax-check-hook 283 | (lambda () (setq flycheck-testsuite-syntax-checker-finished t))) 284 | 285 | (defconst flycheck-testsuite-checker-wait-time 5 286 | "Time to wait until a checker is finished in seconds. 287 | 288 | After this time has elapsed, the checker is considered to have 289 | failed, and the test aborted with failure.") 290 | 291 | (defun flycheck-testsuite-wait-for-syntax-checker () 292 | "Wait until the syntax check in the current buffer is finished." 293 | (let ((starttime (float-time))) 294 | (while (and (not flycheck-testsuite-syntax-checker-finished) 295 | (< (- (float-time) starttime) flycheck-testsuite-checker-wait-time)) 296 | (sleep-for 1)) 297 | (unless (< (- (float-time) starttime) flycheck-testsuite-checker-wait-time) 298 | (flycheck-stop-checker) 299 | (error "Syntax check did not finish after %s seconds" 300 | flycheck-testsuite-checker-wait-time))) 301 | (setq flycheck-testsuite-syntax-checker-finished nil)) 302 | 303 | (defun flycheck-testsuite-buffer-sync () 304 | "Check the current buffer synchronously." 305 | (setq flycheck-testsuite-syntax-checker-finished nil) 306 | (should (not (flycheck-running-p))) 307 | (flycheck-mode) ; This will only start a deferred check, 308 | (flycheck-buffer) ; so we need an explicit manual check 309 | ;; After starting the check, the checker should either be running now, or 310 | ;; already be finished (if it was fast). 311 | (should (or flycheck-current-process 312 | flycheck-testsuite-syntax-checker-finished)) 313 | ;; Also there should be no deferred check pending anymore 314 | (should-not (flycheck-deferred-check-p)) 315 | (flycheck-testsuite-wait-for-syntax-checker)) 316 | 317 | (defun flycheck-testsuite-ensure-clear () 318 | "Clear the current buffer. 319 | 320 | Raise an assertion error if the buffer is not clear afterwards." 321 | (flycheck-clear) 322 | (should (not flycheck-current-errors)) 323 | (should (not (--any? (overlay-get it 'flycheck-overlay) 324 | (overlays-in (point-min) (point-max)))))) 325 | 326 | 327 | ;;;; Test predicates 328 | (defun flycheck-testsuite-should-overlay (overlay error) 329 | "Test that OVERLAY is in REGION and corresponds to ERROR." 330 | (let* ((region (flycheck-error-region-for-mode error 'symbols)) 331 | (message (flycheck-error-message error)) 332 | (level (flycheck-error-level error)) 333 | (face (if (eq level 'warning) 334 | 'flycheck-warning 335 | 'flycheck-error)) 336 | (category (if (eq level 'warning) 337 | 'flycheck-warning-overlay 338 | 'flycheck-error-overlay)) 339 | (fringe-icon (if (eq level 'warning) 340 | '(left-fringe question-mark flycheck-fringe-warning) 341 | `(left-fringe ,flycheck-fringe-exclamation-mark 342 | flycheck-fringe-error)))) 343 | (should overlay) 344 | (should (overlay-get overlay 'flycheck-overlay)) 345 | (should (= (overlay-start overlay) (car region))) 346 | (should (= (overlay-end overlay) (cdr region))) 347 | (should (eq (overlay-get overlay 'face) face)) 348 | (should (equal (get-char-property 0 'display 349 | (overlay-get overlay 'before-string)) 350 | fringe-icon)) 351 | (should (eq (overlay-get overlay 'category) category)) 352 | (should (equal (overlay-get overlay 'flycheck-error) error)) 353 | (should (string= (overlay-get overlay 'help-echo) message)))) 354 | 355 | (defun flycheck-testsuite-should-error (line column message level &rest properties) 356 | "Test that EXPECTED-ERR is an error in the current buffer. 357 | 358 | Test that the error is contained in `flycheck-current-errors', 359 | and that there is an overlay for this error at the correct 360 | position. 361 | 362 | LINE, COLUMN, MESSAGE and LEVEL are the expected properties of 363 | the error. PROPERTIES specify additional properties of the expected ERROR. 364 | 365 | Signal a test failure if this error is not present." 366 | (let* ((filename (-if-let (member (plist-member properties :filename)) 367 | (cadr member) (buffer-file-name))) 368 | (checker (-if-let (member (plist-member properties :checker)) 369 | (cadr member) (or flycheck-checker flycheck-last-checker))) 370 | (buffer (or (plist-get properties :buffer) (current-buffer))) 371 | (real-error (flycheck-error-new 372 | :buffer buffer :filename filename :checker checker 373 | :line line :column column :message message :level level)) 374 | (overlay (--first (equal (overlay-get it 'flycheck-error) real-error) 375 | (flycheck-overlays-in 0 (+ 1 (buffer-size)))))) 376 | (should (-contains? flycheck-current-errors real-error)) 377 | (flycheck-testsuite-should-overlay overlay real-error))) 378 | 379 | (defun flycheck-testsuite-should-errors (&rest errors) 380 | "Test that the current buffers has ERRORS. 381 | 382 | Without ERRORS test that there are any errors in the current 383 | buffer. 384 | 385 | With ERRORS, test that each error in ERRORS is present in the 386 | current buffer, and that the number of errors in the current 387 | buffer is equal to the number of given ERRORS. 388 | 389 | Each error in ERRORS is a list as expected by 390 | `flycheck-testsuite-should-error'." 391 | (if (not errors) 392 | (should flycheck-current-errors) 393 | (dolist (err errors) 394 | (apply #'flycheck-testsuite-should-error err)) 395 | (should (= (length errors) (length flycheck-current-errors))) 396 | (should (= (length errors) 397 | (length (flycheck-overlays-in (point-min) (point-max))))))) 398 | 399 | (defun flycheck-testsuite-should-syntax-check 400 | (resource-file modes disabled-checkers &rest errors) 401 | "Test a syntax check in RESOURCE-FILE with MODES. 402 | 403 | RESOURCE-FILE is the file to check. MODES is a single major mode 404 | symbol or a list thereof, specifying the major modes to syntax 405 | check with. DISABLED-CHECKERS is a syntax checker or a list 406 | thereof to disable before checking the file. ERRORS is the list 407 | of expected errors." 408 | (when (symbolp modes) 409 | (setq modes (list modes))) 410 | (when (symbolp disabled-checkers) 411 | (setq disabled-checkers (list disabled-checkers))) 412 | (--each modes 413 | (let ((flycheck-checkers (--remove (memq it disabled-checkers) 414 | flycheck-checkers))) 415 | (flycheck-testsuite-with-resource-buffer resource-file 416 | (funcall it) 417 | ;; Configure config file locating for unit tests 418 | (--each '(flycheck-locate-config-file-absolute-path 419 | flycheck-testsuite-locate-config-file) 420 | (add-hook 'flycheck-locate-config-file-functions it :append :local)) 421 | (let ((process-hook-called 0)) 422 | (add-hook 'flycheck-process-error-functions 423 | (lambda (_err) 424 | (setq process-hook-called (1+ process-hook-called)) 425 | nil) 426 | nil :local) 427 | (flycheck-testsuite-buffer-sync) 428 | (should (= process-hook-called (length errors)))) 429 | (if errors 430 | (apply #'flycheck-testsuite-should-errors errors) 431 | (should-not flycheck-current-errors)) 432 | (flycheck-testsuite-ensure-clear))))) 433 | 434 | (provide 'test-helper) 435 | 436 | ;; Local Variables: 437 | ;; coding: utf-8 438 | ;; End: 439 | 440 | ;;; test-helper.el ends here 441 | -------------------------------------------------------------------------------- /doc/fdl-1.3.texi: -------------------------------------------------------------------------------- 1 | @c The GNU Free Documentation License. 2 | @center Version 1.3, 3 November 2008 3 | 4 | @c This file is intended to be included within another document, 5 | @c hence no sectioning command or @node. 6 | 7 | @display 8 | Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. 9 | @uref{http://fsf.org/} 10 | 11 | Everyone is permitted to copy and distribute verbatim copies 12 | of this license document, but changing it is not allowed. 13 | @end display 14 | 15 | @enumerate 0 16 | @item 17 | PREAMBLE 18 | 19 | The purpose of this License is to make a manual, textbook, or other 20 | functional and useful document @dfn{free} in the sense of freedom: to 21 | assure everyone the effective freedom to copy and redistribute it, 22 | with or without modifying it, either commercially or noncommercially. 23 | Secondarily, this License preserves for the author and publisher a way 24 | to get credit for their work, while not being considered responsible 25 | for modifications made by others. 26 | 27 | This License is a kind of ``copyleft'', which means that derivative 28 | works of the document must themselves be free in the same sense. It 29 | complements the GNU General Public License, which is a copyleft 30 | license designed for free software. 31 | 32 | We have designed this License in order to use it for manuals for free 33 | software, because free software needs free documentation: a free 34 | program should come with manuals providing the same freedoms that the 35 | software does. But this License is not limited to software manuals; 36 | it can be used for any textual work, regardless of subject matter or 37 | whether it is published as a printed book. We recommend this License 38 | principally for works whose purpose is instruction or reference. 39 | 40 | @item 41 | APPLICABILITY AND DEFINITIONS 42 | 43 | This License applies to any manual or other work, in any medium, that 44 | contains a notice placed by the copyright holder saying it can be 45 | distributed under the terms of this License. Such a notice grants a 46 | world-wide, royalty-free license, unlimited in duration, to use that 47 | work under the conditions stated herein. The ``Document'', below, 48 | refers to any such manual or work. Any member of the public is a 49 | licensee, and is addressed as ``you''. You accept the license if you 50 | copy, modify or distribute the work in a way requiring permission 51 | under copyright law. 52 | 53 | A ``Modified Version'' of the Document means any work containing the 54 | Document or a portion of it, either copied verbatim, or with 55 | modifications and/or translated into another language. 56 | 57 | A ``Secondary Section'' is a named appendix or a front-matter section 58 | of the Document that deals exclusively with the relationship of the 59 | publishers or authors of the Document to the Document's overall 60 | subject (or to related matters) and contains nothing that could fall 61 | directly within that overall subject. (Thus, if the Document is in 62 | part a textbook of mathematics, a Secondary Section may not explain 63 | any mathematics.) The relationship could be a matter of historical 64 | connection with the subject or with related matters, or of legal, 65 | commercial, philosophical, ethical or political position regarding 66 | them. 67 | 68 | The ``Invariant Sections'' are certain Secondary Sections whose titles 69 | are designated, as being those of Invariant Sections, in the notice 70 | that says that the Document is released under this License. If a 71 | section does not fit the above definition of Secondary then it is not 72 | allowed to be designated as Invariant. The Document may contain zero 73 | Invariant Sections. If the Document does not identify any Invariant 74 | Sections then there are none. 75 | 76 | The ``Cover Texts'' are certain short passages of text that are listed, 77 | as Front-Cover Texts or Back-Cover Texts, in the notice that says that 78 | the Document is released under this License. A Front-Cover Text may 79 | be at most 5 words, and a Back-Cover Text may be at most 25 words. 80 | 81 | A ``Transparent'' copy of the Document means a machine-readable copy, 82 | represented in a format whose specification is available to the 83 | general public, that is suitable for revising the document 84 | straightforwardly with generic text editors or (for images composed of 85 | pixels) generic paint programs or (for drawings) some widely available 86 | drawing editor, and that is suitable for input to text formatters or 87 | for automatic translation to a variety of formats suitable for input 88 | to text formatters. A copy made in an otherwise Transparent file 89 | format whose markup, or absence of markup, has been arranged to thwart 90 | or discourage subsequent modification by readers is not Transparent. 91 | An image format is not Transparent if used for any substantial amount 92 | of text. A copy that is not ``Transparent'' is called ``Opaque''. 93 | 94 | Examples of suitable formats for Transparent copies include plain 95 | ASCII without markup, Texinfo input format, La@TeX{} input 96 | format, SGML or XML using a publicly available 97 | DTD, and standard-conforming simple HTML, 98 | PostScript or PDF designed for human modification. Examples 99 | of transparent image formats include PNG, XCF and 100 | JPG@. Opaque formats include proprietary formats that can be 101 | read and edited only by proprietary word processors, SGML or 102 | XML for which the DTD and/or processing tools are 103 | not generally available, and the machine-generated HTML, 104 | PostScript or PDF produced by some word processors for 105 | output purposes only. 106 | 107 | The ``Title Page'' means, for a printed book, the title page itself, 108 | plus such following pages as are needed to hold, legibly, the material 109 | this License requires to appear in the title page. For works in 110 | formats which do not have any title page as such, ``Title Page'' means 111 | the text near the most prominent appearance of the work's title, 112 | preceding the beginning of the body of the text. 113 | 114 | The ``publisher'' means any person or entity that distributes copies 115 | of the Document to the public. 116 | 117 | A section ``Entitled XYZ'' means a named subunit of the Document whose 118 | title either is precisely XYZ or contains XYZ in parentheses following 119 | text that translates XYZ in another language. (Here XYZ stands for a 120 | specific section name mentioned below, such as ``Acknowledgements'', 121 | ``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' 122 | of such a section when you modify the Document means that it remains a 123 | section ``Entitled XYZ'' according to this definition. 124 | 125 | The Document may include Warranty Disclaimers next to the notice which 126 | states that this License applies to the Document. These Warranty 127 | Disclaimers are considered to be included by reference in this 128 | License, but only as regards disclaiming warranties: any other 129 | implication that these Warranty Disclaimers may have is void and has 130 | no effect on the meaning of this License. 131 | 132 | @item 133 | VERBATIM COPYING 134 | 135 | You may copy and distribute the Document in any medium, either 136 | commercially or noncommercially, provided that this License, the 137 | copyright notices, and the license notice saying this License applies 138 | to the Document are reproduced in all copies, and that you add no other 139 | conditions whatsoever to those of this License. You may not use 140 | technical measures to obstruct or control the reading or further 141 | copying of the copies you make or distribute. However, you may accept 142 | compensation in exchange for copies. If you distribute a large enough 143 | number of copies you must also follow the conditions in section 3. 144 | 145 | You may also lend copies, under the same conditions stated above, and 146 | you may publicly display copies. 147 | 148 | @item 149 | COPYING IN QUANTITY 150 | 151 | If you publish printed copies (or copies in media that commonly have 152 | printed covers) of the Document, numbering more than 100, and the 153 | Document's license notice requires Cover Texts, you must enclose the 154 | copies in covers that carry, clearly and legibly, all these Cover 155 | Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on 156 | the back cover. Both covers must also clearly and legibly identify 157 | you as the publisher of these copies. The front cover must present 158 | the full title with all words of the title equally prominent and 159 | visible. You may add other material on the covers in addition. 160 | Copying with changes limited to the covers, as long as they preserve 161 | the title of the Document and satisfy these conditions, can be treated 162 | as verbatim copying in other respects. 163 | 164 | If the required texts for either cover are too voluminous to fit 165 | legibly, you should put the first ones listed (as many as fit 166 | reasonably) on the actual cover, and continue the rest onto adjacent 167 | pages. 168 | 169 | If you publish or distribute Opaque copies of the Document numbering 170 | more than 100, you must either include a machine-readable Transparent 171 | copy along with each Opaque copy, or state in or with each Opaque copy 172 | a computer-network location from which the general network-using 173 | public has access to download using public-standard network protocols 174 | a complete Transparent copy of the Document, free of added material. 175 | If you use the latter option, you must take reasonably prudent steps, 176 | when you begin distribution of Opaque copies in quantity, to ensure 177 | that this Transparent copy will remain thus accessible at the stated 178 | location until at least one year after the last time you distribute an 179 | Opaque copy (directly or through your agents or retailers) of that 180 | edition to the public. 181 | 182 | It is requested, but not required, that you contact the authors of the 183 | Document well before redistributing any large number of copies, to give 184 | them a chance to provide you with an updated version of the Document. 185 | 186 | @item 187 | MODIFICATIONS 188 | 189 | You may copy and distribute a Modified Version of the Document under 190 | the conditions of sections 2 and 3 above, provided that you release 191 | the Modified Version under precisely this License, with the Modified 192 | Version filling the role of the Document, thus licensing distribution 193 | and modification of the Modified Version to whoever possesses a copy 194 | of it. In addition, you must do these things in the Modified Version: 195 | 196 | @enumerate A 197 | @item 198 | Use in the Title Page (and on the covers, if any) a title distinct 199 | from that of the Document, and from those of previous versions 200 | (which should, if there were any, be listed in the History section 201 | of the Document). You may use the same title as a previous version 202 | if the original publisher of that version gives permission. 203 | 204 | @item 205 | List on the Title Page, as authors, one or more persons or entities 206 | responsible for authorship of the modifications in the Modified 207 | Version, together with at least five of the principal authors of the 208 | Document (all of its principal authors, if it has fewer than five), 209 | unless they release you from this requirement. 210 | 211 | @item 212 | State on the Title page the name of the publisher of the 213 | Modified Version, as the publisher. 214 | 215 | @item 216 | Preserve all the copyright notices of the Document. 217 | 218 | @item 219 | Add an appropriate copyright notice for your modifications 220 | adjacent to the other copyright notices. 221 | 222 | @item 223 | Include, immediately after the copyright notices, a license notice 224 | giving the public permission to use the Modified Version under the 225 | terms of this License, in the form shown in the Addendum below. 226 | 227 | @item 228 | Preserve in that license notice the full lists of Invariant Sections 229 | and required Cover Texts given in the Document's license notice. 230 | 231 | @item 232 | Include an unaltered copy of this License. 233 | 234 | @item 235 | Preserve the section Entitled ``History'', Preserve its Title, and add 236 | to it an item stating at least the title, year, new authors, and 237 | publisher of the Modified Version as given on the Title Page. If 238 | there is no section Entitled ``History'' in the Document, create one 239 | stating the title, year, authors, and publisher of the Document as 240 | given on its Title Page, then add an item describing the Modified 241 | Version as stated in the previous sentence. 242 | 243 | @item 244 | Preserve the network location, if any, given in the Document for 245 | public access to a Transparent copy of the Document, and likewise 246 | the network locations given in the Document for previous versions 247 | it was based on. These may be placed in the ``History'' section. 248 | You may omit a network location for a work that was published at 249 | least four years before the Document itself, or if the original 250 | publisher of the version it refers to gives permission. 251 | 252 | @item 253 | For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve 254 | the Title of the section, and preserve in the section all the 255 | substance and tone of each of the contributor acknowledgements and/or 256 | dedications given therein. 257 | 258 | @item 259 | Preserve all the Invariant Sections of the Document, 260 | unaltered in their text and in their titles. Section numbers 261 | or the equivalent are not considered part of the section titles. 262 | 263 | @item 264 | Delete any section Entitled ``Endorsements''. Such a section 265 | may not be included in the Modified Version. 266 | 267 | @item 268 | Do not retitle any existing section to be Entitled ``Endorsements'' or 269 | to conflict in title with any Invariant Section. 270 | 271 | @item 272 | Preserve any Warranty Disclaimers. 273 | @end enumerate 274 | 275 | If the Modified Version includes new front-matter sections or 276 | appendices that qualify as Secondary Sections and contain no material 277 | copied from the Document, you may at your option designate some or all 278 | of these sections as invariant. To do this, add their titles to the 279 | list of Invariant Sections in the Modified Version's license notice. 280 | These titles must be distinct from any other section titles. 281 | 282 | You may add a section Entitled ``Endorsements'', provided it contains 283 | nothing but endorsements of your Modified Version by various 284 | parties---for example, statements of peer review or that the text has 285 | been approved by an organization as the authoritative definition of a 286 | standard. 287 | 288 | You may add a passage of up to five words as a Front-Cover Text, and a 289 | passage of up to 25 words as a Back-Cover Text, to the end of the list 290 | of Cover Texts in the Modified Version. Only one passage of 291 | Front-Cover Text and one of Back-Cover Text may be added by (or 292 | through arrangements made by) any one entity. If the Document already 293 | includes a cover text for the same cover, previously added by you or 294 | by arrangement made by the same entity you are acting on behalf of, 295 | you may not add another; but you may replace the old one, on explicit 296 | permission from the previous publisher that added the old one. 297 | 298 | The author(s) and publisher(s) of the Document do not by this License 299 | give permission to use their names for publicity for or to assert or 300 | imply endorsement of any Modified Version. 301 | 302 | @item 303 | COMBINING DOCUMENTS 304 | 305 | You may combine the Document with other documents released under this 306 | License, under the terms defined in section 4 above for modified 307 | versions, provided that you include in the combination all of the 308 | Invariant Sections of all of the original documents, unmodified, and 309 | list them all as Invariant Sections of your combined work in its 310 | license notice, and that you preserve all their Warranty Disclaimers. 311 | 312 | The combined work need only contain one copy of this License, and 313 | multiple identical Invariant Sections may be replaced with a single 314 | copy. If there are multiple Invariant Sections with the same name but 315 | different contents, make the title of each such section unique by 316 | adding at the end of it, in parentheses, the name of the original 317 | author or publisher of that section if known, or else a unique number. 318 | Make the same adjustment to the section titles in the list of 319 | Invariant Sections in the license notice of the combined work. 320 | 321 | In the combination, you must combine any sections Entitled ``History'' 322 | in the various original documents, forming one section Entitled 323 | ``History''; likewise combine any sections Entitled ``Acknowledgements'', 324 | and any sections Entitled ``Dedications''. You must delete all 325 | sections Entitled ``Endorsements.'' 326 | 327 | @item 328 | COLLECTIONS OF DOCUMENTS 329 | 330 | You may make a collection consisting of the Document and other documents 331 | released under this License, and replace the individual copies of this 332 | License in the various documents with a single copy that is included in 333 | the collection, provided that you follow the rules of this License for 334 | verbatim copying of each of the documents in all other respects. 335 | 336 | You may extract a single document from such a collection, and distribute 337 | it individually under this License, provided you insert a copy of this 338 | License into the extracted document, and follow this License in all 339 | other respects regarding verbatim copying of that document. 340 | 341 | @item 342 | AGGREGATION WITH INDEPENDENT WORKS 343 | 344 | A compilation of the Document or its derivatives with other separate 345 | and independent documents or works, in or on a volume of a storage or 346 | distribution medium, is called an ``aggregate'' if the copyright 347 | resulting from the compilation is not used to limit the legal rights 348 | of the compilation's users beyond what the individual works permit. 349 | When the Document is included in an aggregate, this License does not 350 | apply to the other works in the aggregate which are not themselves 351 | derivative works of the Document. 352 | 353 | If the Cover Text requirement of section 3 is applicable to these 354 | copies of the Document, then if the Document is less than one half of 355 | the entire aggregate, the Document's Cover Texts may be placed on 356 | covers that bracket the Document within the aggregate, or the 357 | electronic equivalent of covers if the Document is in electronic form. 358 | Otherwise they must appear on printed covers that bracket the whole 359 | aggregate. 360 | 361 | @item 362 | TRANSLATION 363 | 364 | Translation is considered a kind of modification, so you may 365 | distribute translations of the Document under the terms of section 4. 366 | Replacing Invariant Sections with translations requires special 367 | permission from their copyright holders, but you may include 368 | translations of some or all Invariant Sections in addition to the 369 | original versions of these Invariant Sections. You may include a 370 | translation of this License, and all the license notices in the 371 | Document, and any Warranty Disclaimers, provided that you also include 372 | the original English version of this License and the original versions 373 | of those notices and disclaimers. In case of a disagreement between 374 | the translation and the original version of this License or a notice 375 | or disclaimer, the original version will prevail. 376 | 377 | If a section in the Document is Entitled ``Acknowledgements'', 378 | ``Dedications'', or ``History'', the requirement (section 4) to Preserve 379 | its Title (section 1) will typically require changing the actual 380 | title. 381 | 382 | @item 383 | TERMINATION 384 | 385 | You may not copy, modify, sublicense, or distribute the Document 386 | except as expressly provided under this License. Any attempt 387 | otherwise to copy, modify, sublicense, or distribute it is void, and 388 | will automatically terminate your rights under this License. 389 | 390 | However, if you cease all violation of this License, then your license 391 | from a particular copyright holder is reinstated (a) provisionally, 392 | unless and until the copyright holder explicitly and finally 393 | terminates your license, and (b) permanently, if the copyright holder 394 | fails to notify you of the violation by some reasonable means prior to 395 | 60 days after the cessation. 396 | 397 | Moreover, your license from a particular copyright holder is 398 | reinstated permanently if the copyright holder notifies you of the 399 | violation by some reasonable means, this is the first time you have 400 | received notice of violation of this License (for any work) from that 401 | copyright holder, and you cure the violation prior to 30 days after 402 | your receipt of the notice. 403 | 404 | Termination of your rights under this section does not terminate the 405 | licenses of parties who have received copies or rights from you under 406 | this License. If your rights have been terminated and not permanently 407 | reinstated, receipt of a copy of some or all of the same material does 408 | not give you any rights to use it. 409 | 410 | @item 411 | FUTURE REVISIONS OF THIS LICENSE 412 | 413 | The Free Software Foundation may publish new, revised versions 414 | of the GNU Free Documentation License from time to time. Such new 415 | versions will be similar in spirit to the present version, but may 416 | differ in detail to address new problems or concerns. See 417 | @uref{http://www.gnu.org/copyleft/}. 418 | 419 | Each version of the License is given a distinguishing version number. 420 | If the Document specifies that a particular numbered version of this 421 | License ``or any later version'' applies to it, you have the option of 422 | following the terms and conditions either of that specified version or 423 | of any later version that has been published (not as a draft) by the 424 | Free Software Foundation. If the Document does not specify a version 425 | number of this License, you may choose any version ever published (not 426 | as a draft) by the Free Software Foundation. If the Document 427 | specifies that a proxy can decide which future versions of this 428 | License can be used, that proxy's public statement of acceptance of a 429 | version permanently authorizes you to choose that version for the 430 | Document. 431 | 432 | @item 433 | RELICENSING 434 | 435 | ``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any 436 | World Wide Web server that publishes copyrightable works and also 437 | provides prominent facilities for anybody to edit those works. A 438 | public wiki that anybody can edit is an example of such a server. A 439 | ``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the 440 | site means any set of copyrightable works thus published on the MMC 441 | site. 442 | 443 | ``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 444 | license published by Creative Commons Corporation, a not-for-profit 445 | corporation with a principal place of business in San Francisco, 446 | California, as well as future copyleft versions of that license 447 | published by that same organization. 448 | 449 | ``Incorporate'' means to publish or republish a Document, in whole or 450 | in part, as part of another Document. 451 | 452 | An MMC is ``eligible for relicensing'' if it is licensed under this 453 | License, and if all works that were first published under this License 454 | somewhere other than this MMC, and subsequently incorporated in whole 455 | or in part into the MMC, (1) had no cover texts or invariant sections, 456 | and (2) were thus incorporated prior to November 1, 2008. 457 | 458 | The operator of an MMC Site may republish an MMC contained in the site 459 | under CC-BY-SA on the same site at any time before August 1, 2009, 460 | provided the MMC is eligible for relicensing. 461 | 462 | @end enumerate 463 | 464 | @page 465 | @heading ADDENDUM: How to use this License for your documents 466 | 467 | To use this License in a document you have written, include a copy of 468 | the License in the document and put the following copyright and 469 | license notices just after the title page: 470 | 471 | @smallexample 472 | @group 473 | Copyright (C) @var{year} @var{your name}. 474 | Permission is granted to copy, distribute and/or modify this document 475 | under the terms of the GNU Free Documentation License, Version 1.3 476 | or any later version published by the Free Software Foundation; 477 | with no Invariant Sections, no Front-Cover Texts, and no Back-Cover 478 | Texts. A copy of the license is included in the section entitled ``GNU 479 | Free Documentation License''. 480 | @end group 481 | @end smallexample 482 | 483 | If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, 484 | replace the ``with@dots{}Texts.''@: line with this: 485 | 486 | @smallexample 487 | @group 488 | with the Invariant Sections being @var{list their titles}, with 489 | the Front-Cover Texts being @var{list}, and with the Back-Cover Texts 490 | being @var{list}. 491 | @end group 492 | @end smallexample 493 | 494 | If you have Invariant Sections without Cover Texts, or some other 495 | combination of the three, merge those two alternatives to suit the 496 | situation. 497 | 498 | If your document contains nontrivial examples of program code, we 499 | recommend releasing these examples in parallel under your choice of 500 | free software license, such as the GNU General Public License, 501 | to permit their use in free software. 502 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | . 675 | --------------------------------------------------------------------------------