├── .gitignore ├── .editorconfig ├── LICENSE ├── package.json ├── README.md ├── lib ├── Main.coffee ├── PropertyProvider.coffee ├── MethodProvider.coffee └── AbstractProvider.coffee ├── LICENSE-atom-autocomplete-php ├── styles └── main.less ├── CHANGELOG.md └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | npm-debug.log 3 | node_modules 4 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | insert_final_newline = true 6 | trim_trailing_whitespace = true 7 | indent_style = space 8 | indent_size = 4 9 | charset = utf-8 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | © 2015 Tom Gerrits 2 | 3 | This program is free software: you can redistribute it and/or modify 4 | it under the terms of the GNU General Public License as published by 5 | the Free Software Foundation, either version 3 of the License, or 6 | (at your option) any later version. 7 | 8 | This program is distributed in the hope that it will be useful, 9 | but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | GNU General Public License for more details. 12 | 13 | You should have received a copy of the GNU General Public License 14 | along with this program. If not, see . 15 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "php-integrator-annotations", 3 | "main": "./lib/Main", 4 | "version": "1.2.0", 5 | "description": "Shows annotations (e.g. for overriden methods interface implementations) in your PHP source code.", 6 | "repository": "php-integrator/atom-annotations", 7 | "license": "GPL-3.0", 8 | "engines": { 9 | "atom": ">=1.13.0 <2.0.0" 10 | }, 11 | "consumedServices": { 12 | "php-integrator.service": { 13 | "versions": { 14 | "^3.0": "setService" 15 | } 16 | } 17 | }, 18 | "dependencies": {}, 19 | "keywords": [ 20 | "php", 21 | "annotations", 22 | "integrator", 23 | "integration", 24 | "php-integrator" 25 | ] 26 | } 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # php-integrator/atom-annotations 2 | ## Legacy 3 | This is a legacy version that required PHP >= 7.1. Since 3.6, its functionality is included in the [base package](https://github.com/php-integrator/atom-base) and installing it separately is no longer necessary. 4 | 5 | ## About 6 | ![Screenshot](http://ipfs.pics/ipfs/QmTMju5ZZtcHBxKzfMfER35QkNik84Yva3HMbTz5LwMVdC) 7 | 8 | This package provides annotations for your PHP source code using [PHP Integrator](https://github.com/php-integrator/atom-base). 9 | 10 | **Note that the [php-integrator-base](https://github.com/php-integrator/atom-base) package is required and needs to be set up correctly for this package to function correctly.** 11 | 12 | What is included? 13 | * Annotations for class methods that are implementing a method from an interface. 14 | * Annotations for class methods and properties that are overriding base class or trait members. 15 | * Tooltips on mouse over that clarify why the annotations are cluttering your gutter with additional icons. 16 | * Annotations for overrides and implementations can be clicked to navigate to respectively the method being overridden or implemented. 17 | 18 | ![GPLv3 Logo](http://gplv3.fsf.org/gplv3-127x51.png) 19 | -------------------------------------------------------------------------------- /lib/Main.coffee: -------------------------------------------------------------------------------- 1 | module.exports = 2 | ###* 3 | * List of annotation providers. 4 | ### 5 | providers: [] 6 | 7 | ###* 8 | * Activates the package. 9 | ### 10 | activate: -> 11 | 12 | ###* 13 | * Deactivates the package. 14 | ### 15 | deactivate: -> 16 | @deactivateProviders() 17 | 18 | ###* 19 | * Activates the providers using the specified service. 20 | ### 21 | activateProviders: (service) -> 22 | @providers = [] 23 | 24 | MethodProvider = require './MethodProvider' 25 | PropertyProvider = require './PropertyProvider' 26 | 27 | @providers.push new MethodProvider() 28 | @providers.push new PropertyProvider() 29 | 30 | for provider in @providers 31 | provider.activate(service) 32 | 33 | ###* 34 | * Deactivates any active providers. 35 | ### 36 | deactivateProviders: () -> 37 | for provider in @providers 38 | provider.deactivate() 39 | 40 | @providers = [] 41 | 42 | ###* 43 | * Sets the php-integrator service. 44 | * 45 | * @param {mixed} service 46 | ### 47 | setService: (service) -> 48 | @activateProviders(service) 49 | 50 | {Disposable} = require 'atom' 51 | 52 | return new Disposable => @deactivateProviders() 53 | -------------------------------------------------------------------------------- /LICENSE-atom-autocomplete-php: -------------------------------------------------------------------------------- 1 | This project was forked from atom-autocomplete-php, thus the original code base 2 | was licensed under the MIT license. It can still be found at [1]. The original 3 | license is located below. 4 | 5 | [1] https://github.com/Peekmo/atom-autocomplete-php 6 | 7 | The MIT License (MIT) 8 | 9 | Copyright (c) 2014-2015 Axel Anceau 10 | 11 | Permission is hereby granted, free of charge, to any person obtaining a copy of 12 | this software and associated documentation files (the "Software"), to deal in 13 | the Software without restriction, including without limitation the rights to 14 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 15 | the Software, and to permit persons to whom the Software is furnished to do so, 16 | subject to the following conditions: 17 | 18 | The above copyright notice and this permission notice shall be included in all 19 | copies or substantial portions of the Software. 20 | 21 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 22 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 23 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 24 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 25 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 26 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 27 | -------------------------------------------------------------------------------- /styles/main.less: -------------------------------------------------------------------------------- 1 | // The ui-variables file is provided by base themes provided by Atom. 2 | // 3 | // See https://github.com/atom/atom-dark-ui/blob/master/stylesheets/ui-variables.less 4 | // for a full listing of what's available. 5 | @import "ui-variables"; 6 | @import "octicon-utf-codes"; 7 | 8 | atom-text-editor { 9 | .gutter { 10 | .line-number { 11 | &.override { 12 | .icon-right { 13 | opacity: 1.0; 14 | cursor: pointer; 15 | visibility: visible; 16 | 17 | &:before { 18 | content: @link; 19 | color: @ui-site-color-2; 20 | } 21 | } 22 | } 23 | 24 | &.abstract-override { 25 | .icon-right { 26 | opacity: 1.0; 27 | cursor: pointer; 28 | visibility: visible; 29 | 30 | &:before { 31 | content: @link; 32 | color: @ui-site-color-5; 33 | } 34 | } 35 | } 36 | 37 | &.implementations { 38 | .icon-right { 39 | opacity: 1.0; 40 | cursor: pointer; 41 | visibility: visible; 42 | 43 | &:before { 44 | content: @link; 45 | color: @ui-site-color-3; 46 | } 47 | } 48 | } 49 | } 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 1.2.0 (base 3.0.0) 2 | * Upgrade to base 3.0.0. 3 | 4 | ## 1.1.1 5 | * Fix deprecations. 6 | 7 | ## 1.1.0 (base 2.0.0) 8 | * The dependency on `sub-atom` has been removed. 9 | * Annotations that are obscuring code folds in the gutter will no longer trigger them. 10 | * Annotations will no longer constantly flicker whenever indexing occurs (i.e. whenever the buffer changes). 11 | * Performance should have improved a bit as fewer event handlers are constantly being registered and removed. 12 | * The PHP documentation will now be openend when clicking an implementation or override of a built-in class or interface. 13 | 14 | ## 1.0.3 15 | * Rename the package and repository. 16 | 17 | ## 1.0.2 18 | * Fix an accidental incorrect release. 19 | 20 | ## 1.0.1 21 | * Fix the version specifier not being compatible with newer versions of the base service. 22 | 23 | ## 1.0.0 (base 1.0.0) 24 | * Updated to work with the most recent service from the base package. 25 | 26 | ## 0.4.1 (base 0.9.0) 27 | * Improve performance by removing the need for regular expression scanning. 28 | 29 | ## 0.4.0 (base 0.8.0) 30 | * "Overrides" for abstract methods will now be shown in a different color and with a different tooltip to allow a visual distinction between them and actual overrides as the former are more "implementation" and don't actually remove any existing functionality by overriding. 31 | 32 | ## 0.3.2 (base 0.7.0) 33 | * Updated to work with the most recent service from the base package. 34 | 35 | ## 0.3.1 36 | * Catch exceptions properly. 37 | 38 | ## 0.3.0 (base 0.6.0) 39 | * Files with multiple classes should now properly have their annotations registered, instead of just the first. 40 | * Overrides for methods and properties originating from a trait in the *same* class will now list the name of the trait instead of the class name itself. Without this, if `Foo` overrides a method from one of its own traits, the annotation would list `Overrides method from Foo`, which is confusing. 41 | 42 | ## 0.2.4 (base 0.5.0) 43 | * Annotations will now be rescanned when indexing succeeds instead of on save. 44 | 45 | ## 0.2.3 (base 0.4.0) 46 | * Fixed static methods not being annotated. 47 | * Fixed clicking property override annotations not navigating to the correct line. 48 | 49 | ## 0.2.2 50 | * Properly wait for the language-php package to become active. 51 | 52 | ## 0.2.1 53 | * Stop using maintainHistory to be compatible with upcoming Atom 1.3. 54 | 55 | ## 0.2.0 56 | * Clicking annotations for overrides or implementations of built-in PHP structures will now no longer open an empty editor. 57 | * The providers now fetch information from the base service asynchronouly using promises and the amount of calls to the service were reduced significantly, improving performance. 58 | 59 | ## 0.1.0 60 | * Initial release. 61 | -------------------------------------------------------------------------------- /lib/PropertyProvider.coffee: -------------------------------------------------------------------------------- 1 | {Range} = require 'atom' 2 | 3 | AbstractProvider = require './AbstractProvider' 4 | 5 | module.exports = 6 | 7 | ##* 8 | # Provides annotations for member properties that are overrides. 9 | ## 10 | class MethodProvider extends AbstractProvider 11 | ###* 12 | * @inheritdoc 13 | ### 14 | registerAnnotations: (editor) -> 15 | path = editor.getPath() 16 | 17 | return null if not path 18 | 19 | successHandler = (classInfo) => 20 | return null if not classInfo 21 | 22 | for name, property of classInfo.properties 23 | continue if not property.override 24 | continue if property.declaringStructure.fqcn != classInfo.fqcn 25 | 26 | range = new Range([property.startLine - 1, 0], [property.startLine, -1]) 27 | 28 | @placeAnnotation(editor, range, @extractAnnotationInfo(property)) 29 | 30 | failureHandler = () => 31 | # Just do nothing. 32 | 33 | getClassListHandler = (classesInEditor) => 34 | promises = [] 35 | 36 | for fqcn, classInfo of classesInEditor 37 | promises.push @service.getClassInfo(fqcn).then(successHandler, failureHandler) 38 | 39 | return Promise.all(promises) 40 | 41 | return @service.getClassListForFile(path).then(getClassListHandler, failureHandler) 42 | 43 | ###* 44 | * Fetches annotation info for the specified context. 45 | * 46 | * @param {Object} context 47 | * 48 | * @return {Object} 49 | ### 50 | extractAnnotationInfo: (context) -> 51 | # NOTE: We deliberately show the declaring class here, not the structure (which could be a trait). However, 52 | # if the method is overriding a trait method from the *same* class, we show the trait name, as it would be 53 | # strange to put an annotation in "Foo" saying "Overrides method from Foo". 54 | overriddenFromFqcn = context.override.declaringClass.fqcn 55 | 56 | if overriddenFromFqcn == context.declaringClass.fqcn 57 | overriddenFromFqcn = context.override.declaringStructure.fqcn 58 | 59 | return { 60 | lineNumberClass : 'override' 61 | tooltipText : 'Overrides property from ' + overriddenFromFqcn 62 | extraData : context.override 63 | } 64 | 65 | ###* 66 | * @inheritdoc 67 | ### 68 | handleMouseClick: (event, editor, annotationInfo) -> 69 | # 'filename' can be false for overrides of members from PHP's built-in classes (e.g. Exception). 70 | if annotationInfo.extraData.declaringStructure.filename 71 | atom.workspace.open(annotationInfo.extraData.declaringStructure.filename, { 72 | initialLine : annotationInfo.extraData.declaringStructure.startLineMember - 1, 73 | searchAllPanes : true 74 | }) 75 | 76 | ###* 77 | * @inheritdoc 78 | ### 79 | removePopover: () -> 80 | if @attachedPopover 81 | @attachedPopover.dispose() 82 | @attachedPopover = null 83 | -------------------------------------------------------------------------------- /lib/MethodProvider.coffee: -------------------------------------------------------------------------------- 1 | shell = require 'shell' 2 | 3 | {Range} = require 'atom' 4 | 5 | AbstractProvider = require './AbstractProvider' 6 | 7 | module.exports = 8 | 9 | ##* 10 | # Provides annotations for member methods that are overrides or interface implementations. 11 | ## 12 | class MethodProvider extends AbstractProvider 13 | ###* 14 | * @inheritdoc 15 | ### 16 | registerAnnotations: (editor) -> 17 | path = editor.getPath() 18 | 19 | return null if not path 20 | 21 | successHandler = (classInfo) => 22 | return null if not classInfo 23 | 24 | for name, method of classInfo.methods 25 | continue if not method.override and method.implementations?.length == 0 26 | continue if method.declaringStructure.fqcn != classInfo.fqcn 27 | 28 | range = new Range([method.startLine - 1, 0], [method.startLine, -1]) 29 | 30 | @placeAnnotation(editor, range, @extractAnnotationInfo(method)) 31 | 32 | failureHandler = () => 33 | # Just do nothing. 34 | 35 | getClassListHandler = (classesInEditor) => 36 | promises = [] 37 | 38 | for fqcn, classInfo of classesInEditor 39 | promises.push @service.getClassInfo(fqcn).then(successHandler, failureHandler) 40 | 41 | return Promise.all(promises) 42 | 43 | return @service.getClassListForFile(path).then(getClassListHandler, failureHandler) 44 | 45 | ###* 46 | * Fetches annotation info for the specified context. 47 | * 48 | * @param {Object} context 49 | * 50 | * @return {Object} 51 | ### 52 | extractAnnotationInfo: (context) -> 53 | extraData = null 54 | tooltipText = '' 55 | lineNumberClass = '' 56 | 57 | if context.override 58 | # NOTE: We deliberately show the declaring class here, not the structure (which could be a trait). However, 59 | # if the method is overriding a trait method from the *same* class, we show the trait name, as it would be 60 | # strange to put an annotation in "Foo" saying "Overrides method from Foo". 61 | overriddenFromFqcn = context.override.declaringClass.fqcn 62 | 63 | if overriddenFromFqcn == context.declaringClass.fqcn 64 | overriddenFromFqcn = context.override.declaringStructure.fqcn 65 | 66 | extraData = context.override 67 | 68 | if not context.override.wasAbstract 69 | lineNumberClass = 'override' 70 | tooltipText = 'Overrides method from ' + overriddenFromFqcn 71 | 72 | else 73 | lineNumberClass = 'abstract-override' 74 | tooltipText = 'Implements abstract method from ' + overriddenFromFqcn 75 | 76 | else 77 | # NOTE: We deliberately show the declaring class here, not the structure (which could be a trait). 78 | extraData = context.implementations[0] 79 | lineNumberClass = 'implementations' 80 | tooltipText = 'Implements method for ' + extraData.declaringStructure.fqcn 81 | 82 | extraData.fqcn = context.fqcn 83 | 84 | return { 85 | lineNumberClass : lineNumberClass 86 | tooltipText : tooltipText 87 | extraData : extraData 88 | } 89 | 90 | ###* 91 | * @inheritdoc 92 | ### 93 | handleMouseClick: (event, editor, annotationInfo) -> 94 | # 'filename' can be false for overrides of members from PHP's built-in classes (e.g. Exception). 95 | if annotationInfo.extraData.declaringStructure.filename 96 | atom.workspace.open(annotationInfo.extraData.declaringStructure.filename, { 97 | initialLine : annotationInfo.extraData.declaringStructure.startLineMember - 1, 98 | searchAllPanes : true 99 | }) 100 | 101 | else 102 | url = @service.getDocumentationUrlForClassMethod( 103 | annotationInfo.extraData.declaringStructure.fqcn, 104 | annotationInfo.extraData.fqcn 105 | ) 106 | 107 | shell.openExternal(url) 108 | 109 | ###* 110 | * @inheritdoc 111 | ### 112 | removePopover: () -> 113 | if @attachedPopover 114 | @attachedPopover.dispose() 115 | @attachedPopover = null 116 | -------------------------------------------------------------------------------- /lib/AbstractProvider.coffee: -------------------------------------------------------------------------------- 1 | module.exports = 2 | 3 | ##* 4 | # Base class for providers. 5 | ## 6 | class AbstractProvider 7 | ###* 8 | * List of markers that are present for each file. 9 | * 10 | * @var {Object} 11 | ### 12 | markers: null 13 | 14 | ###* 15 | * A mapping of file names to a list of annotations that are inside the gutter. 16 | * 17 | * @var {Object} 18 | ### 19 | annotations: null 20 | 21 | ###* 22 | * The service (that can be used to query the source code and contains utility methods). 23 | ### 24 | service: null 25 | 26 | constructor: () -> 27 | # Constructer here because otherwise the object is shared between instances. 28 | @markers = {} 29 | @annotations = {} 30 | 31 | ###* 32 | * Initializes this provider. 33 | * 34 | * @param {mixed} service 35 | ### 36 | activate: (@service) -> 37 | dependentPackage = 'language-php' 38 | 39 | # It could be that the dependent package is already active, in that case we can continue immediately. If not, 40 | # we'll need to wait for the listener to be invoked 41 | if atom.packages.isPackageActive(dependentPackage) 42 | @doActualInitialization() 43 | 44 | atom.packages.onDidActivatePackage (packageData) => 45 | return if packageData.name != dependentPackage 46 | 47 | @doActualInitialization() 48 | 49 | atom.packages.onDidDeactivatePackage (packageData) => 50 | return if packageData.name != dependentPackage 51 | 52 | @deactivate() 53 | 54 | ###* 55 | * Does the actual initialization. 56 | ### 57 | doActualInitialization: () -> 58 | atom.workspace.observeTextEditors (editor) => 59 | if /text.html.php$/.test(editor.getGrammar().scopeName) 60 | # Allow the active project to settle before registering for the first time. 61 | setTimeout(() => 62 | @registerAnnotations(editor) 63 | @registerEvents(editor) 64 | , 100) 65 | 66 | # When you go back to only have one pane the events are lost, so need to re-register. 67 | atom.workspace.onDidDestroyPane (pane) => 68 | panes = atom.workspace.getPanes() 69 | 70 | if panes.length == 1 71 | @registerEventsForPane(panes[0]) 72 | 73 | # Having to re-register events as when a new pane is created the old panes lose the events. 74 | atom.workspace.onDidAddPane (observedPane) => 75 | panes = atom.workspace.getPanes() 76 | 77 | for pane in panes 78 | if pane != observedPane 79 | @registerEventsForPane(pane) 80 | 81 | # Ensure annotations are updated. 82 | @service.onDidFinishIndexing (data) => 83 | editor = @findTextEditorByPath(data.path) 84 | 85 | if editor? 86 | @rescan(editor) 87 | 88 | ###* 89 | * Retrieves the text editor that is managing the file with the specified path. 90 | * 91 | * @param {String} path 92 | * 93 | * @return {TextEditor|null} 94 | ### 95 | findTextEditorByPath: (path) -> 96 | for textEditor in atom.workspace.getTextEditors() 97 | if textEditor.getPath() == path 98 | return textEditor 99 | 100 | return null 101 | 102 | ###* 103 | * Registers the necessary event handlers for the editors in the specified pane. 104 | * 105 | * @param {Pane} pane 106 | ### 107 | registerEventsForPane: (pane) -> 108 | for paneItem in pane.items 109 | if atom.workspace.isTextEditor(paneItem) 110 | if /text.html.php$/.test(paneItem.getGrammar().scopeName) 111 | @registerEvents(paneItem) 112 | 113 | ###* 114 | * Deactives the provider. 115 | ### 116 | deactivate: () -> 117 | @removeAnnotations() 118 | 119 | ###* 120 | * Registers the necessary event handlers. 121 | * 122 | * @param {TextEditor} editor TextEditor to register events to. 123 | ### 124 | registerEvents: (editor) -> 125 | # Ticket #107 - Mouseout isn't generated until the mouse moves, even when scrolling (with the keyboard or 126 | # mouse). If the element goes out of the view in the meantime, its HTML element disappears, never removing 127 | # it. 128 | editor.onDidDestroy () => 129 | @removePopover() 130 | 131 | editor.onDidStopChanging () => 132 | @removePopover() 133 | 134 | textEditorElement = atom.views.getView(editor) 135 | 136 | textEditorElement.querySelector('.horizontal-scrollbar')?.addEventListener 'scroll', (event) => 137 | @removePopover() 138 | 139 | textEditorElement.querySelector('.vertical-scrollbar')?.addEventListener 'scroll', (event) => 140 | @removePopover() 141 | 142 | gutterContainerElement = textEditorElement.querySelector('.gutter-container') 143 | 144 | mouseOverHandler = (event) => 145 | annotation = @getRelevantAnnotationForEvent(editor, event) 146 | 147 | return if not annotation? 148 | 149 | @handleMouseOver(event, editor, annotation.annotationInfo) 150 | 151 | mouseOutHandler = (event) => 152 | annotation = @getRelevantAnnotationForEvent(editor, event) 153 | 154 | return if not annotation? 155 | 156 | @handleMouseOut(event, editor, annotation.annotationInfo) 157 | 158 | mouseDownHandler = (event) => 159 | annotation = @getRelevantAnnotationForEvent(editor, event) 160 | 161 | return if not annotation? 162 | 163 | # Don't collapse or expand the fold in the gutter, if there is any. 164 | event.stopPropagation() 165 | 166 | @handleMouseClick(event, editor, annotation.annotationInfo) 167 | 168 | gutterContainerElement?.addEventListener('mouseover', mouseOverHandler) 169 | gutterContainerElement?.addEventListener('mouseout', mouseOutHandler) 170 | gutterContainerElement?.addEventListener('mousedown', mouseDownHandler) 171 | 172 | 173 | ###* 174 | * @param {TextEditor} editor 175 | * @param {Object} event 176 | * 177 | * @return {Object|null} 178 | ### 179 | getRelevantAnnotationForEvent: (editor, event) -> 180 | if event.target.className.indexOf('icon-right') != -1 181 | longTitle = editor.getLongTitle() 182 | 183 | lineEventOccurredOn = parseInt(event.target.parentElement.dataset.bufferRow) 184 | 185 | if longTitle of @annotations 186 | for annotation in @annotations[longTitle] 187 | if annotation.line == lineEventOccurredOn 188 | return annotation 189 | 190 | return null 191 | 192 | ###* 193 | * Registers the annotations. 194 | * 195 | * @param {TextEditor} editor The editor to search through. 196 | * 197 | * @return {Promise|null} 198 | ### 199 | registerAnnotations: (editor) -> 200 | throw new Error("This method is abstract and must be implemented!") 201 | 202 | ###* 203 | * Places an annotation at the specified line and row text. 204 | * 205 | * @param {TextEditor} editor 206 | * @param {Range} range 207 | * @param {Object} annotationInfo 208 | ### 209 | placeAnnotation: (editor, range, annotationInfo) -> 210 | marker = editor.markBufferRange(range, { 211 | invalidate : 'touch' 212 | }) 213 | 214 | decoration = editor.decorateMarker(marker, { 215 | type: 'line-number', 216 | class: annotationInfo.lineNumberClass 217 | }) 218 | 219 | longTitle = editor.getLongTitle() 220 | 221 | if longTitle not of @markers 222 | @markers[longTitle] = [] 223 | 224 | @markers[longTitle].push(marker) 225 | 226 | @registerAnnotationEventHandlers(editor, range.start.row, annotationInfo) 227 | 228 | ###* 229 | * Registers annotation event handlers for the specified row. 230 | * 231 | * @param {TextEditor} editor 232 | * @param {Number} row 233 | * @param {Object} annotationInfo 234 | ### 235 | registerAnnotationEventHandlers: (editor, row, annotationInfo) -> 236 | textEditorElement = atom.views.getView(editor) 237 | gutterContainerElement = textEditorElement.querySelector('.gutter-container') 238 | 239 | do (editor, gutterContainerElement, annotationInfo) => 240 | longTitle = editor.getLongTitle() 241 | 242 | if longTitle not of @annotations 243 | @annotations[longTitle] = [] 244 | 245 | @annotations[longTitle].push({ 246 | line : row 247 | annotationInfo : annotationInfo 248 | }) 249 | 250 | ###* 251 | * Handles the mouse over event on an annotation. 252 | * 253 | * @param {Object} event 254 | * @param {TextEditor} editor 255 | * @param {Object} annotationInfo 256 | ### 257 | handleMouseOver: (event, editor, annotationInfo) -> 258 | if annotationInfo.tooltipText 259 | @removePopover() 260 | 261 | @attachedPopover = @service.createAttachedPopover(event.target) 262 | @attachedPopover.setText(annotationInfo.tooltipText) 263 | @attachedPopover.show() 264 | 265 | ###* 266 | * Handles the mouse out event on an annotation. 267 | * 268 | * @param {Object} event 269 | * @param {TextEditor} editor 270 | * @param {Object} annotationInfo 271 | ### 272 | handleMouseOut: (event, editor, annotationInfo) -> 273 | @removePopover() 274 | 275 | ###* 276 | * Handles the mouse click event on an annotation. 277 | * 278 | * @param {Object} event 279 | * @param {TextEditor} editor 280 | * @param {Object} annotationInfo 281 | ### 282 | handleMouseClick: (event, editor, annotationInfo) -> 283 | 284 | ###* 285 | * Removes the existing popover, if any. 286 | ### 287 | removePopover: () -> 288 | if @attachedPopover 289 | @attachedPopover.dispose() 290 | @attachedPopover = null 291 | 292 | ###* 293 | * Removes any annotations that were created with the specified key. 294 | * 295 | * @param {String} key 296 | ### 297 | removeAnnotationsByKey: (key) -> 298 | for i,marker of @markers[key] 299 | marker.destroy() 300 | 301 | @markers[key] = [] 302 | @annotations[key] = [] 303 | 304 | ###* 305 | * Removes any annotations (across all editors). 306 | ### 307 | removeAnnotations: () -> 308 | for key,markers of @markers 309 | @removeAnnotationsByKey(key) 310 | 311 | @markers = {} 312 | @annotations = {} 313 | 314 | ###* 315 | * Rescans the editor, updating all annotations. 316 | * 317 | * @param {TextEditor} editor The editor to search through. 318 | ### 319 | rescan: (editor) -> 320 | key = editor.getLongTitle() 321 | renamedKey = 'tmp_' + key 322 | 323 | # We rename the markers and remove them afterwards to prevent flicker if the location of the marker does not 324 | # change. 325 | if key of @annotations 326 | @annotations[renamedKey] = @annotations[key] 327 | @annotations[key] = [] 328 | 329 | if key of @markers 330 | @markers[renamedKey] = @markers[key] 331 | @markers[key] = [] 332 | 333 | result = @registerAnnotations(editor) 334 | 335 | if result? 336 | result.then () => 337 | @removeAnnotationsByKey(renamedKey) 338 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------