24 |
25 | ## 💾 Installation
26 |
27 | #### package.el
28 |
29 | This package is available from [JCS-ELPA](https://jcs-emacs.github.io/jcs-elpa/).
30 | Install from these repositories then you should be good to go!
31 |
32 | Normally, you don't need to add `(require 'chatgpt)` to your configuration since
33 | most `'chatgpt` commands are autoload and can be called without loading the module!
34 |
35 | #### use-package
36 |
37 | If you are using [use-package](https://www.emacswiki.org/emacs/UsePackage),
38 | add the following to your `init.el` file:
39 |
40 | ```elisp
41 | (use-package chatgpt :ensure t)
42 | ```
43 |
44 | or with `straight.el`:
45 |
46 | ```elisp
47 | (use-package chatgpt
48 | :straight (chatgpt :type git :host github :repo "emacs-openai/chatgpt"))
49 | ```
50 |
51 | #### Manual installation
52 |
53 | Copy all `.el` files in this repository to `~/.emacs.d/lisp` and add the following:
54 |
55 | ```elisp
56 | (add-to-list 'load-path "~/.emacs.d/lisp/")
57 | (require 'chatgpt)
58 | ```
59 |
60 | ## 🔑 Obtaining API key
61 |
62 | To use this extension, you will need an API key from OpenAI. To obtain one,
63 | follow these steps:
64 |
65 | 1. Go to [OpenAI's website](https://beta.openai.com/account/api-keys). If you
66 | don't have an account, you will need to create one or sign up using your Google
67 | or Microsoft account.
68 | 2. Click on the `Create new secret key` button.
69 | 3. Copy the key and paste into the 'API Key' field under the 'openai' custom group settings.
70 |
71 | When you create a new account, you receive $18 in free credits for the API which
72 | you must use in the first 90 days. You can see pricing information
73 | [here](https://openai.com/api/pricing/). 1000 tokens are about 700 words, and
74 | you can see the token count for each request at the end of the response in the
75 | sidebar.
76 |
77 | ## 🔨 Usage
78 |
79 | Before you can use this package you will need to [set up your API key](https://github.com/emacs-openai/openai#-usage) for openai library.
80 |
81 | To start this package:
82 |
83 | ```
84 | M-x chatgpt
85 | ```
86 |
87 | You will then be asked to insert your response; in this window, you press
88 | return to send the message, and Shift+return
89 | to insert a newline like a normal browser!
90 |
91 | ## 📝 Customization
92 |
93 | #### 🧪 Variables
94 |
95 | - `chatgpt-model` - ID of the model to use. (Default: `"gpt-3.5-turbo"`)
96 | - `chatgpt-max-tokens` - The maximum number of tokens to generate in the completion. (Default: `2000`)
97 | - `chatgpt-temperature` - What sampling temperature to use. (Default: `1.0`)
98 | - `chatgpt-input-method` - The method to receive input. (Default: `'window`)
99 | - `chatgpt-display-method` - The method to display buffer. (Default: `nil`)
100 | - `chatgpt-spinner-type` - Type of the spinner. (Default: `'moon`)
101 | - `chatgpt-display-tokens-info` - Non-nil we display tokens information for each request. (Default: `t`)
102 | - `chatgpt-animate-text` - Display text gradually instead of output it all at once. (Default: `t`)
103 | - `chatgpt-animate-fps` - Frame per seconds to display text animation. (Default: `5`)
104 |
105 | ## 🔗 References
106 |
107 | - [ChatGPT.el](https://github.com/joshcho/ChatGPT.el)
108 | - [gptel](https://github.com/karthink/gptel)
109 |
110 | ## 🛠️ Contribute
111 |
112 | [](http://makeapullrequest.com)
113 | [](https://github.com/bbatsov/emacs-lisp-style-guide)
114 | [](https://www.paypal.me/jcs090218)
115 | [](https://www.patreon.com/jcs090218)
116 |
117 | If you would like to contribute to this project, you may either
118 | clone and make pull requests to this repository. Or you can
119 | clone the project and establish your own branch of this tool.
120 | Any methods are welcome!
121 |
122 | ### 🔬 Development
123 |
124 | To run the test locally, you will need the following tools:
125 |
126 | - [Eask](https://emacs-eask.github.io/)
127 | - [Make](https://www.gnu.org/software/make/) (optional)
128 |
129 | Install all dependencies and development dependencies:
130 |
131 | ```sh
132 | eask install-deps --dev
133 | ```
134 |
135 | To test the package's installation:
136 |
137 | ```sh
138 | eask package
139 | eask install
140 | ```
141 |
142 | To test compilation:
143 |
144 | ```sh
145 | eask compile
146 | ```
147 |
148 | **🪧 The following steps are optional, but we recommend you follow these lint results!**
149 |
150 | The built-in `checkdoc` linter:
151 |
152 | ```sh
153 | eask lint checkdoc
154 | ```
155 |
156 | The standard `package` linter:
157 |
158 | ```sh
159 | eask lint package
160 | ```
161 |
162 | *📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
163 |
164 | ## ⚜️ License
165 |
166 | This program is free software; you can redistribute it and/or modify
167 | it under the terms of the GNU General Public License as published by
168 | the Free Software Foundation, either version 3 of the License, or
169 | (at your option) any later version.
170 |
171 | This program is distributed in the hope that it will be useful,
172 | but WITHOUT ANY WARRANTY; without even the implied warranty of
173 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
174 | GNU General Public License for more details.
175 |
176 | You should have received a copy of the GNU General Public License
177 | along with this program. If not, see .
178 |
179 | See [`LICENSE`](./LICENSE.txt) for details.
180 |
--------------------------------------------------------------------------------
/chatgpt.el:
--------------------------------------------------------------------------------
1 | ;;; chatgpt.el --- Use ChatGPT inside Emacs -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2023-2025 Shen, Jen-Chieh
4 |
5 | ;; Author: Shen, Jen-Chieh
6 | ;; Maintainer: Shen, Jen-Chieh
7 | ;; URL: https://github.com/emacs-openai/chatgpt
8 | ;; Version: 0.1.0
9 | ;; Package-Requires: ((emacs "28.1") (openai "0.1.0") (lv "0.0") (ht "2.0") (markdown-mode "2.1") (spinner "1.7.4"))
10 | ;; Keywords: comm openai
11 |
12 | ;; This file is not part of GNU Emacs.
13 |
14 | ;; This program is free software: you can redistribute it and/or modify
15 | ;; it under the terms of the GNU General Public License as published by
16 | ;; the Free Software Foundation, either version 3 of the License, or
17 | ;; (at your option) any later version.
18 |
19 | ;; This program is distributed in the hope that it will be useful,
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 | ;; GNU General Public License for more details.
23 |
24 | ;; You should have received a copy of the GNU General Public License
25 | ;; along with this program. If not, see .
26 |
27 | ;;; Commentary:
28 | ;;
29 | ;; Use ChatGPT inside Emacs
30 | ;;
31 |
32 | ;;; Code:
33 |
34 | (require 'cl-lib)
35 | (require 'let-alist)
36 | (require 'subr-x)
37 |
38 | (require 'openai)
39 | (require 'lv)
40 | (require 'ht)
41 | (require 'markdown-mode)
42 | (require 'spinner)
43 |
44 | (defgroup chatgpt nil
45 | "Use ChatGPT inside Emacs."
46 | :prefix "chatgpt-"
47 | :group 'comm
48 | :link '(url-link :tag "Repository" "https://github.com/emacs-openai/chatgpt"))
49 |
50 | (defcustom chatgpt-model "gpt-3.5-turbo"
51 | "Model to use for chat."
52 | :type 'string
53 | :group 'chatgpt)
54 |
55 | (defcustom chatgpt-max-tokens 2000
56 | "The maximum number of tokens to generate in the completion."
57 | :type 'integer
58 | :group 'chatgpt)
59 |
60 | (defcustom chatgpt-temperature 1.0
61 | "What sampling temperature to use."
62 | :type 'number
63 | :group 'chatgpt)
64 |
65 | (defcustom chatgpt-top-p 1.0
66 | "Nucleus sampling parameter."
67 | :type 'number
68 | :group 'chatgpt)
69 |
70 | (defcustom chatgpt-input-method 'window
71 | "The method receive input."
72 | :type '(choice (const :tag "Read from minibuffer" minibuffer)
73 | (const :tag "Read inside new window" window))
74 | :group 'chatgpt)
75 |
76 | (defcustom chatgpt-display-method nil
77 | "The method to display buffer."
78 | :type '(choice (const :tag "Target display function." function)
79 | (const :tag "Use default function." nil))
80 | :group 'chatgpt)
81 |
82 | (defcustom chatgpt-window-prompt "Type response here..."
83 | "Text inserted when window is created."
84 | :type 'string
85 | :group 'chatgpt)
86 |
87 | (defcustom chatgpt-inhibit-input-afterward t
88 | "Stop input after sending one."
89 | :type 'boolean
90 | :group 'chatgpt)
91 |
92 | (defcustom chatgpt-spinner-type 'moon
93 | "The type of the spinner."
94 | :type '(choice (const :tag "Key to variable `spinner-types'" symbol)
95 | (const :tag "Vector of characters" vector))
96 | :group 'openai)
97 |
98 | (defcustom chatgpt-display-tokens-info t
99 | "Non-nil we display tokens information for each request."
100 | :type 'boolean
101 | :group 'chatgpt)
102 |
103 | (defcustom chatgpt-priority 100
104 | "Overlays' priority."
105 | :type 'integer
106 | :group 'chatgpt)
107 |
108 | (defcustom chatgpt-animate-text t
109 | "Display text gradually instead of output it all at once."
110 | :type 'boolean
111 | :group 'chatgpt)
112 |
113 | (defcustom chatgpt-animate-fps 5
114 | "Frame per seconds to display text animation."
115 | :type 'integer
116 | :group 'chatgpt)
117 |
118 | (defconst chatgpt-buffer-name-format "*ChatGPT: <%s>*"
119 | "Name of the buffer to use for the `chatgpt' instance.")
120 |
121 | (defvar chatgpt-instances (ht-create)
122 | "List of instances, each pair is consist of (index . buffer).")
123 |
124 | (defvar-local chatgpt-instance nil
125 | "Instance data for each buffer.")
126 |
127 | (defvar-local chatgpt-chat-history nil
128 | "The chat history use to send request.")
129 |
130 | (defvar-local chatgpt-chat-points nil
131 | "Buffer points every time we add a new message.")
132 |
133 | (defvar-local chatgpt-requesting-p nil
134 | "Non-nil when requesting; waiting for the response.")
135 |
136 | (defvar-local chatgpt-spinner nil
137 | "Spinner.")
138 |
139 | (defvar-local chatgpt-data (ht-create)
140 | "Store other information other than messages.")
141 |
142 | (defvar-local chatgpt--display-pointer 0
143 | "Display pointer for each message to display.")
144 |
145 | (defvar-local chatgpt--text-pointer 1
146 | "Text pointer for text animation.")
147 |
148 | (defvar-local chatgpt-text-timer nil
149 | "Text timer for text animation.")
150 |
151 | (defvar-local chatgpt-animating-p nil
152 | "Non-nil when animating text scroll.")
153 |
154 | (defface chatgpt-user
155 | '((t :inherit font-lock-builtin-face))
156 | "Face used for user."
157 | :group 'chatgpt)
158 |
159 | (defface chatgpt-tip
160 | '((t :foreground "#848484"))
161 | "Face used for tip."
162 | :group 'chatgpt)
163 |
164 | (defface chatgpt-info
165 | '((t :height 0.8 :foreground "#999999"))
166 | "Face added to codemetrics display."
167 | :group 'chatgpt)
168 |
169 | ;;
170 | ;;; Externals
171 |
172 | (declare-function string-pixel-width "ext:subr-x.el")
173 | (declare-function shr-string-pixel-width "ext:shr.el")
174 |
175 | ;;
176 | ;;; Util
177 |
178 | (defmacro chatgpt--with-no-redisplay (&rest body)
179 | "Execute BODY without any redisplay execution."
180 | (declare (indent 0) (debug t))
181 | `(let ((inhibit-redisplay t)
182 | (inhibit-modification-hooks t)
183 | after-focus-change-function
184 | buffer-list-update-hook
185 | display-buffer-alist
186 | window-configuration-change-hook
187 | window-scroll-functions
188 | window-size-change-functions
189 | window-state-change-hook)
190 | ,@body))
191 |
192 | (defmacro chatgpt--with-buffer (buffer &rest body)
193 | "Execute BODY with in BUFFER."
194 | (declare (indent 1) (debug t))
195 | `(when (get-buffer ,buffer)
196 | (with-current-buffer ,buffer ,@body)))
197 |
198 | ;; TODO: Use function `string-pixel-width' after 29.1
199 | (defun chatgpt--string-pixel-width (str)
200 | "Return the width of STR in pixels."
201 | (if (fboundp #'string-pixel-width)
202 | (string-pixel-width str)
203 | (require 'shr)
204 | (shr-string-pixel-width str)))
205 |
206 | (defun chatgpt--str-len (str)
207 | "Calculate STR in pixel width."
208 | (let ((width (frame-char-width))
209 | (len (chatgpt--string-pixel-width str)))
210 | (+ (/ len width)
211 | (if (zerop (% len width)) 0 1)))) ; add one if exceeed
212 |
213 | (defun chatgpt--align (&rest lengths)
214 | "Align sideline string by LENGTHS from the right of the window."
215 | (list (* (window-font-width)
216 | (+ (apply #'+ lengths) (if (display-graphic-p) 1 2)))))
217 |
218 | (defun chatgpt--kill-buffer (buffer-or-name)
219 | "Like function `kill-buffer' (BUFFER-OR-NAME) but in the safe way."
220 | (when-let ((buffer (get-buffer buffer-or-name)))
221 | (when (buffer-live-p buffer)
222 | (kill-buffer buffer))))
223 |
224 | (defun chatgpt--cancel-timer (timer)
225 | "Cancel TIMER."
226 | (when (timerp timer)
227 | (cancel-timer timer)))
228 |
229 | (defun chatgpt--display-buffer (buffer-or-name)
230 | "Wrapper to function `pop-to-buffer'.
231 |
232 | Display buffer from BUFFER-OR-NAME."
233 | (if (functionp chatgpt-display-method)
234 | (funcall chatgpt-display-method buffer-or-name)
235 | (pop-to-buffer buffer-or-name `((display-buffer-in-direction)
236 | (dedicated . t)))))
237 |
238 | (defun chatgpt-busy-p ()
239 | "Return non-nil if session is busy."
240 | (or chatgpt-requesting-p chatgpt-animating-p))
241 |
242 | (defun chatgpt-user ()
243 | "Return the current user."
244 | (if (string-empty-p openai-user)
245 | "user" ; this is free?
246 | openai-user))
247 |
248 | ;;
249 | ;;; Chat Point
250 |
251 | (defun chatgpt-chat-points ()
252 | "Return chat points in correct order."
253 | (reverse chatgpt-chat-points))
254 |
255 | (defun chatgpt-current-chat-point ()
256 | "Return current chat point."
257 | (let ((chat-point))
258 | (cl-some (lambda (pt)
259 | (when (<= pt (point))
260 | (setq chat-point pt)))
261 | chatgpt-chat-points)
262 | chat-point))
263 |
264 | (defun chatgpt-chat-point-index (chat-point)
265 | "Return CHAT-POINT's index."
266 | (cl-position chat-point (chatgpt-chat-points)))
267 |
268 | (defun chatgpt-current-chat-point-index ()
269 | "Return current chat point index."
270 | (chatgpt-chat-point-index (chatgpt-current-chat-point)))
271 |
272 | (defun chatgpt-current-message ()
273 | "Return current message."
274 | (elt chatgpt-chat-history (chatgpt-current-chat-point-index)))
275 |
276 | (defun chatgpt-current-content ()
277 | "Return current content."
278 | (alist-get 'content (chatgpt-current-message)))
279 |
280 | (defun chatgpt-current-role ()
281 | "Return current role."
282 | (alist-get 'role (chatgpt-current-message)))
283 |
284 | (defun chatgpt-shift-chat-points (start delta)
285 | "Shift all chat points after START by DELTA."
286 | (let ((index 0) (pt))
287 | (while (< index (length chatgpt-chat-points))
288 | (setq pt (nth index chatgpt-chat-points))
289 | (when (< start pt)
290 | (setf (nth index chatgpt-chat-points) (+ pt delta)))
291 | (cl-incf index))))
292 |
293 | ;;
294 | ;;; Instances
295 |
296 | (defmacro chatgpt-with-instance (instance &rest body)
297 | "Execute BODY within INSTANCE."
298 | (declare (indent 1))
299 | `(when-let* ((buffer (and ,instance
300 | (get-buffer (cdr ,instance))))
301 | ((buffer-live-p buffer)))
302 | (with-current-buffer buffer
303 | (let ((inhibit-read-only t))
304 | ,@body))))
305 |
306 | (defun chatgpt--live-instances ()
307 | "Return a list of live instances."
308 | (let ((live-instances))
309 | (ht-map (lambda (_ buffer)
310 | (when (and (get-buffer buffer)
311 | (buffer-live-p buffer))
312 | (push buffer live-instances)))
313 | chatgpt-instances)
314 | (reverse live-instances)))
315 |
316 | (defun chatgpt--shown-instances ()
317 | "Return a list of live instances that are displayed on the screen."
318 | (let ((live-instances (chatgpt--live-instances))
319 | (shown-instances))
320 | (dolist (instance live-instances)
321 | (when (get-buffer-window instance)
322 | (push instance shown-instances)))
323 | (reverse shown-instances)))
324 |
325 | (defun chatgpt--new-index ()
326 | "Find killed instance before giving new index."
327 | (let ((target))
328 | (cl-some (lambda (index)
329 | (let ((buffer (ht-get chatgpt-instances index)))
330 | (when (or (not (get-buffer buffer))
331 | (not (buffer-live-p buffer))) ; if buffer is killed
332 | (setq target index)
333 | t)))
334 | (ht-keys chatgpt-instances))
335 | (unless target ; No killed instance?
336 | (setq target (ht-size chatgpt-instances))) ; Create a new one!
337 | target))
338 |
339 | (defun chatgpt-restart-session ()
340 | "Restart session."
341 | (when (eq major-mode #'chatgpt-mode)
342 | (let* ((instance chatgpt-instance)
343 | (index (car instance))
344 | (old-name))
345 | ;; If buffer is alive, kill it!
346 | (chatgpt-with-instance instance
347 | (setq old-name (buffer-name))
348 | (kill-this-buffer))
349 | ;; `old-name' will remain `nil' if buffer is not killed or invalid!
350 | (when old-name
351 | (chatgpt-register-instance index old-name)
352 | (switch-to-buffer old-name)))))
353 |
354 | ;;
355 | ;;; Core
356 |
357 | (defun chatgpt--get-face-height ()
358 | "Make sure we get the face height."
359 | (let ((height (face-attribute 'chatgpt-info :height)))
360 | (if (numberp height) height
361 | 1)))
362 |
363 | (defun chatgpt--create-tokens-overlay (prompt-tokens completion-tokens total-tokens)
364 | "Display tokens information.
365 |
366 | Arguments PROMPT-TOKENS, COMPLETION-TOKENS, and TOTAL-TOKENS are the tokens
367 | information we want to display."
368 | (when chatgpt-display-tokens-info
369 | (let* ((ov (make-overlay (1- (point)) (1- (point)) nil t t))
370 | (content (format "prompt %s, completion %s, total: %s"
371 | prompt-tokens completion-tokens total-tokens))
372 | (content-len (* (chatgpt--str-len content)
373 | (chatgpt--get-face-height)))
374 | (str (concat
375 | (propertize " " 'display
376 | `((space :align-to (- right ,(chatgpt--align (1- content-len))))
377 | (space :width 0))
378 | `cursor t)
379 | (propertize content 'face 'chatgpt-info))))
380 | (overlay-put ov 'chatgpt t)
381 | (overlay-put ov 'priority chatgpt-priority)
382 | (overlay-put ov 'after-string str))))
383 |
384 | (defun chatgpt--add-tokens (data)
385 | "Record all tokens information from DATA."
386 | (let-alist data
387 | (let-alist .usage
388 | ;; First we get the current tokens,
389 | (let ((prompt-tokens (ht-get chatgpt-data 'prompt_tokens 0))
390 | (completion-tokens (ht-get chatgpt-data 'completion_tokens 0))
391 | (total-tokens (ht-get chatgpt-data 'total_tokens 0))
392 | (tokens-history (ht-get chatgpt-data 'tokens_history nil)))
393 | ;; Then we add it up!
394 | (ht-set chatgpt-data 'prompt_tokens (+ prompt-tokens .prompt_tokens))
395 | (ht-set chatgpt-data 'completion_tokens (+ completion-tokens .completion_tokens))
396 | (ht-set chatgpt-data 'total_tokens (+ total-tokens .total_tokens))
397 | (ht-set chatgpt-data 'tokens_history
398 | (append tokens-history
399 | `((,.prompt_tokens ,.completion_tokens ,.total_tokens))))
400 | ;; Render it!
401 | (unless chatgpt-animate-text
402 | (chatgpt--create-tokens-overlay .prompt_tokens .completion_tokens .total_tokens))))))
403 |
404 | (defun chatgpt--add-chat-point ()
405 | "Add a chat point."
406 | (if chatgpt-chat-points
407 | (push (point-max) chatgpt-chat-points)
408 | (push (point-min) chatgpt-chat-points)))
409 |
410 | (defun chatgpt--add-message (role content)
411 | "Add a message to history.
412 |
413 | The data is consist of ROLE and CONTENT."
414 | (chatgpt--add-chat-point)
415 | (setq chatgpt-chat-history
416 | (vconcat (or chatgpt-chat-history '[])
417 | `[((role . ,role)
418 | (content . ,(string-trim content)))])))
419 |
420 | (defun chatgpt--add-response-messages (data)
421 | "Add the message to history from DATA, and return the message itself."
422 | (let-alist data
423 | (mapc (lambda (choice)
424 | (let-alist choice
425 | (let-alist .message
426 | (chatgpt--add-message .role .content))))
427 | .choices)))
428 |
429 | ;;
430 | ;;; Display
431 |
432 | (defun chatgpt--render-markdown (content)
433 | "Render CONTENT in markdown."
434 | (if (featurep 'markdown-mode)
435 | (with-temp-buffer
436 | (insert content)
437 | (delay-mode-hooks (markdown-mode))
438 | (ignore-errors (font-lock-ensure))
439 | (buffer-string))
440 | content))
441 |
442 | (defun chatgpt--fill-region (start end)
443 | "Like function `fill-region' (START to END), improve readability."
444 | (save-restriction
445 | (narrow-to-region start end)
446 | (goto-char (point-min))
447 | (while (not (eobp))
448 | (end-of-line)
449 | (when (< fill-column (current-column))
450 | (fill-region (line-beginning-position) (line-end-position)))
451 | (forward-line 1))))
452 |
453 | (defun chatgpt--cancel-text-timer ()
454 | "Cancel text timer."
455 | (chatgpt--cancel-timer chatgpt-text-timer)
456 | (setq chatgpt-text-timer nil
457 | chatgpt-animating-p nil))
458 |
459 | (defun chatgpt--start-text-timer ()
460 | "Start text timer."
461 | (chatgpt--cancel-text-timer)
462 | (setq chatgpt-text-timer (run-with-timer (/ chatgpt-animate-fps 60.0)
463 | nil
464 | #'chatgpt--do-text-animation
465 | chatgpt-instance)
466 | chatgpt-animating-p t))
467 |
468 | (defun chatgpt--do-text-animation (instance)
469 | "The main loop for text animation for the INSTANCE."
470 | (chatgpt-with-instance instance
471 | (chatgpt--cancel-text-timer)
472 | (let ((message (elt chatgpt-chat-history chatgpt--display-pointer)))
473 | (let-alist message
474 | (goto-char (point-max))
475 | (let* ((is-user (string= (chatgpt-user) .role))
476 | (role (format "<%s>:" .role))
477 | ;; XXX: If messages from user, don't try to render to markdown!
478 | ;; else, messages from OpenAI will most likely going to be
479 | ;; markdown so we render it!
480 | (content (if is-user .content
481 | (chatgpt--render-markdown .content)))
482 | (chunk)
483 | (text-pointer chatgpt--text-pointer)
484 | (done))
485 | (add-face-text-property 0 (length role) 'chatgpt-user nil role)
486 | (with-temp-buffer ; Get the chunk!
487 | ;; --- Standard output ---
488 | (insert role " " content)
489 | (insert "\n\n")
490 | (chatgpt--fill-region (point-min) (point-max))
491 | ;; ---
492 | (goto-char text-pointer)
493 | (unless (eobp)
494 | (forward-word 1)
495 | (setq chunk (buffer-substring text-pointer (point))
496 | text-pointer (point)
497 | done (eobp)))) ; update from temp buffer
498 | (setq chatgpt--text-pointer text-pointer) ; update for local buffer
499 | (insert chunk)
500 | ;; Ready for next message!
501 | (when done
502 | (let* ((tokens-history (ht-get chatgpt-data 'tokens_history))
503 | ;; XXX: Divided by 2 since the data is in pair!
504 | (index (/ chatgpt--display-pointer 2))
505 | (history (nth index tokens-history))
506 | (prompt-tokens (nth 0 history))
507 | (completion-tokens (nth 1 history))
508 | (total-tokens (nth 2 history)))
509 | (chatgpt--create-tokens-overlay prompt-tokens
510 | completion-tokens
511 | total-tokens))
512 | (cl-incf chatgpt--display-pointer)
513 | (setq chatgpt--text-pointer 1)))))
514 | (if (< chatgpt--display-pointer (length chatgpt-chat-history))
515 | (chatgpt--start-text-timer)
516 | (spinner-stop chatgpt-spinner))))
517 |
518 | (defun chatgpt--display-messages-at-once ()
519 | "If variable `chatgpt-animate-text' is nil, we display messages all at once."
520 | (while (< chatgpt--display-pointer (length chatgpt-chat-history))
521 | (let ((message (elt chatgpt-chat-history chatgpt--display-pointer)))
522 | (let-alist message
523 | (goto-char (point-max))
524 | (let* ((start (point))
525 | (is-user (string= (chatgpt-user) .role))
526 | (role (format "<%s>:" .role))
527 | ;; XXX: If messages from user, don't try to render to markdown!
528 | ;; else, messages from OpenAI will most likely going to be
529 | ;; markdown so we render it!
530 | (content (if is-user .content
531 | (chatgpt--render-markdown .content))))
532 | (add-face-text-property 0 (length role) 'chatgpt-user nil role)
533 | (insert role " " content)
534 | (insert "\n\n")
535 | (chatgpt--fill-region start (point)))))
536 | (cl-incf chatgpt--display-pointer)))
537 |
538 | (defun chatgpt--display-messages ()
539 | "Display all messages to latest response."
540 | (when (zerop chatgpt--display-pointer) ; clear up the tip message
541 | (erase-buffer))
542 | (if chatgpt-animate-text
543 | (unless (timerp chatgpt-text-timer) ; when is already running, don't interfere it
544 | (spinner-start chatgpt-spinner)
545 | (chatgpt--start-text-timer))
546 | (chatgpt--display-messages-at-once)))
547 |
548 | (defun chatgpt-send-response (response)
549 | "Send RESPONSE to ChatGPT."
550 | (let ((user (chatgpt-user))
551 | (instance chatgpt-instance))
552 | (when (string-empty-p response)
553 | (user-error "[INFO] Invalid response or instruction: %s" response))
554 | (chatgpt--add-message user response) ; add user's response
555 | (chatgpt-with-instance instance
556 | (let (chatgpt-animate-text)
557 | (chatgpt--display-messages))) ; display it
558 | (setq chatgpt-requesting-p t)
559 | (spinner-start chatgpt-spinner)
560 | (openai-chat chatgpt-chat-history
561 | (lambda (data)
562 | (chatgpt-with-instance instance
563 | (setq chatgpt-requesting-p nil)
564 | (spinner-stop chatgpt-spinner)
565 | (unless openai-error
566 | (chatgpt--add-response-messages data)
567 | (chatgpt--display-messages)
568 | (chatgpt--add-tokens data))))
569 | :model chatgpt-model
570 | :max-tokens chatgpt-max-tokens
571 | :temperature chatgpt-temperature
572 | :top-p chatgpt-top-p
573 | :user user)))
574 |
575 | (defun chatgpt-type-response ()
576 | "Type response to OpenAI."
577 | (interactive)
578 | (cond
579 | (chatgpt-requesting-p
580 | (message "[BUSY] Waiting for OpanAI to response..."))
581 | (chatgpt-animating-p
582 | (message "[BUSY] Waiting for animation to finish..."))
583 | (t
584 | (cl-case chatgpt-input-method
585 | (`minibuffer
586 | (chatgpt-send-response (read-string "Type response: ")))
587 | (`window
588 | (chatgpt--start-input chatgpt-instance))
589 | (t
590 | (user-error "Invalid input method: %s" chatgpt-input-method))))))
591 |
592 | ;;
593 | ;;; Input
594 |
595 | (defconst chatgpt-input-buffer-name "*ChatGPT-Input*"
596 | "Buffer name to receive input.")
597 |
598 | (defvar chatgpt-input-instance nil
599 | "The current instance; there is only one instance at a time.")
600 |
601 | (defun chatgpt-input-exit ()
602 | "Exit the input."
603 | (interactive)
604 | (chatgpt--kill-buffer chatgpt-input-buffer-name))
605 |
606 | (defun chatgpt--start-input (instance)
607 | "Start input from INSTANCE."
608 | (chatgpt-input-exit)
609 | (let ((dir (if (window-parameter nil 'window-side)
610 | 'bottom 'down))
611 | (buffer (get-buffer-create chatgpt-input-buffer-name)))
612 | ;; XXX: Without this, the highlighting at the end wouldn't work!?
613 | (chatgpt--with-no-redisplay
614 | (with-current-buffer buffer
615 | (chatgpt-input-mode)
616 | (setq chatgpt-input-instance instance)
617 | (erase-buffer)
618 | (insert chatgpt-window-prompt)
619 | (call-interactively #'set-mark-command)
620 | (goto-char (point-min)))) ; waiting for deletion
621 | (pop-to-buffer buffer `((display-buffer-in-direction)
622 | (direction . ,dir)
623 | (dedicated . t)
624 | (window-height . fit-window-to-buffer)))))
625 |
626 | (defun chatgpt-input-send ()
627 | "Send the input."
628 | (interactive)
629 | (cond
630 | ((not (eq major-mode #'chatgpt-input-mode)) ) ; does nothing
631 | (chatgpt-requesting-p
632 | (message "[BUSY] Waiting for OpanAI to response..."))
633 | ((region-active-p)
634 | (delete-region (region-beginning) (region-end)))
635 | (t
636 | (let ((response (buffer-string)))
637 | (chatgpt-with-instance chatgpt-input-instance
638 | (chatgpt-send-response response))
639 | (erase-buffer))
640 | (when chatgpt-inhibit-input-afterward
641 | (chatgpt-input-exit)))))
642 |
643 | (defun chatgpt-input--post-command ()
644 | "Execution after input."
645 | (let ((max-lines (line-number-at-pos (point-max))))
646 | (fit-window-to-buffer)
647 | (enlarge-window (- max-lines (window-text-height)))))
648 |
649 | (defun chatgpt-input-header-line ()
650 | "The display for input header line."
651 | (format " [Session] %s" (cdr chatgpt-input-instance)))
652 |
653 | (defvar chatgpt-input-mode-map
654 | (let ((map (make-sparse-keymap)))
655 | (define-key map (kbd "S-") #'newline)
656 | (define-key map (kbd "RET") #'chatgpt-input-send)
657 | map)
658 | "Keymap for `chatgpt-input-mode'.")
659 |
660 | (define-derived-mode chatgpt-input-mode fundamental-mode "ChatGPT Input"
661 | "Major mode for `chatgpt-input-mode'.
662 |
663 | \\"
664 | (setq-local header-line-format `((:eval (chatgpt-input-header-line))))
665 | (add-hook 'post-command-hook #'chatgpt-input--post-command nil t))
666 |
667 | ;;
668 | ;;; Edit
669 |
670 | (defconst chatgpt-edit-buffer-name "*ChatGPT-Edit*"
671 | "Buffer name to receive edit.")
672 |
673 | (defvar chatgpt-edit-instance nil
674 | "The current instance; there is only one instance at a time.")
675 |
676 | (defvar chatgpt-edit-chat-point-index nil
677 | "Store the chat point index.")
678 |
679 | (defun chatgpt-edit-exit ()
680 | "Exit the edit."
681 | (interactive)
682 | (chatgpt--kill-buffer chatgpt-edit-buffer-name))
683 |
684 | (defun chatgpt-edit-start (instance)
685 | "Start edit from INSTANCE."
686 | (chatgpt-edit-exit)
687 | (let ((dir (if (window-parameter nil 'window-side)
688 | 'bottom 'down))
689 | (buffer (get-buffer-create chatgpt-edit-buffer-name))
690 | (content (chatgpt-current-content))
691 | (index (chatgpt-current-chat-point-index)))
692 | ;; XXX: Without this, the highlighting at the end wouldn't work!?
693 | (chatgpt--with-no-redisplay
694 | (with-current-buffer buffer
695 | (chatgpt-edit-mode)
696 | (setq chatgpt-edit-instance instance
697 | chatgpt-edit-chat-point-index index)
698 | (erase-buffer)
699 | (insert content)))
700 | (pop-to-buffer buffer `((display-buffer-in-direction)
701 | (direction . ,dir)
702 | (dedicated . t)
703 | (window-height . fit-window-to-buffer)))))
704 |
705 | (defun chatgpt-edit-send ()
706 | "Send the edit."
707 | (interactive)
708 | (cond
709 | ((not (eq major-mode #'chatgpt-edit-mode)) ) ; do nothing
710 | (chatgpt-requesting-p
711 | (message "[BUSY] Waiting for OpanAI to response..."))
712 | ((region-active-p)
713 | (delete-region (region-beginning) (region-end)))
714 | (t
715 | (let ((response (buffer-string)))
716 | (chatgpt-with-instance chatgpt-edit-instance
717 | ;; Update display!
718 | (let* ((start (chatgpt-current-chat-point))
719 | (old-len (length response))
720 | (new-len (length (chatgpt-current-content)))
721 | (diff (- old-len new-len)))
722 | (goto-char start)
723 | (search-forward ">: " (line-end-position) t) ; XXX: Improve this!
724 | (delete-region (point) (+ (point) new-len))
725 | (insert response)
726 | (chatgpt--fill-region start (point))
727 | (chatgpt-shift-chat-points start diff))
728 |
729 | ;; Update history!
730 | (setf (elt chatgpt-chat-history chatgpt-edit-chat-point-index)
731 | `((role . ,(chatgpt-user))
732 | (content . ,(string-trim response)))))
733 | (erase-buffer))
734 | (when chatgpt-inhibit-input-afterward
735 | (chatgpt-edit-exit)))))
736 |
737 | (defvar chatgpt-edit-mode-map
738 | (let ((map (make-sparse-keymap)))
739 | (define-key map (kbd "S-") #'newline)
740 | (define-key map (kbd "RET") #'chatgpt-edit-send)
741 | map)
742 | "Keymap for `chatgpt-edit-mode'.")
743 |
744 | (define-derived-mode chatgpt-edit-mode fundamental-mode "ChatGPT Edit"
745 | "Major mode for `chatgpt-edit-mode'.
746 |
747 | \\"
748 | (setq-local header-line-format `((:eval (chatgpt-input-header-line))))
749 | (add-hook 'post-command-hook #'chatgpt-input--post-command nil t))
750 |
751 | ;;
752 | ;;; Info
753 |
754 | (defun chatgpt--pre-command-once (&rest _)
755 | "One time pre-command after Easky command."
756 | ;; XXX: We pass on to next post-command!
757 | (remove-hook 'pre-command-hook #'chatgpt--pre-command-once)
758 | (add-hook 'post-command-hook #'chatgpt--post-command-once))
759 |
760 | (defun chatgpt--post-command-once ()
761 | "One time post-command after info command."
762 | ;; XXX: This will allow us to scroll in the lv's window!
763 | (unless (equal lv-wnd (selected-window))
764 | ;; Once we select window other than lv's window, then we kill it!
765 | (remove-hook 'post-command-hook #'chatgpt--post-command-once)
766 | (lv-delete-window)))
767 |
768 | (defun chatgpt-info ()
769 | "Show session information."
770 | (interactive)
771 | (when (eq major-mode #'chatgpt-mode)
772 | (lv-message
773 | (concat
774 | (format "session: %s" (cdr chatgpt-instance)) "\n"
775 | (format "history size: %s" (length chatgpt-chat-history))
776 | "\n\n"
777 | (format "prompt_tokens: %s | completion_tokens: %s | total_tokens: %s"
778 | (ht-get chatgpt-data 'prompt_tokens 0)
779 | (ht-get chatgpt-data 'completion_tokens 0)
780 | (ht-get chatgpt-data 'total_tokens 0))
781 | "\n\n"
782 | (format "model: %s" chatgpt-model) "\n"
783 | (format "max_tokens: %s" chatgpt-max-tokens) "\n"
784 | (format "temperature: %s" chatgpt-temperature) "\n"
785 | (format "top-p: %s" chatgpt-top-p) "\n"
786 | (format "user: %s" (chatgpt-user))))
787 | ;; Register event to cancel lv window!
788 | (add-hook 'pre-command-hook #'chatgpt--pre-command-once)))
789 |
790 | ;;
791 | ;;; Entry
792 |
793 | (defun chatgpt--clear-side-fields ()
794 | "Kill side fileds."
795 | (let ((instances chatgpt-instances))
796 | (chatgpt--with-buffer chatgpt-input-buffer-name
797 | (when (equal instances chatgpt-instances)
798 | (kill-this-buffer)))
799 | (chatgpt--with-buffer chatgpt-edit-buffer-name
800 | (when (equal instances chatgpt-instances)
801 | (kill-this-buffer)))))
802 |
803 | (defun chatgpt-mode--kill-buffer-hook (&rest _)
804 | "Kill buffer hook."
805 | (ht-clear chatgpt-data)
806 | (spinner-stop chatgpt-spinner)
807 | (chatgpt--cancel-text-timer)
808 | (chatgpt--clear-side-fields))
809 |
810 | (defun chatgpt-header-line ()
811 | "The display for header line."
812 | (format " %s[Session] %s [History] %s [User] %s"
813 | (if-let ((frame (spinner-print chatgpt-spinner)))
814 | (concat frame " ")
815 | "")
816 | (cdr chatgpt-instance)
817 | (length chatgpt-chat-history)
818 | (chatgpt-user)))
819 |
820 | (defvar chatgpt-mode-map
821 | (let ((map (make-sparse-keymap)))
822 | (define-key map (kbd "RET") #'chatgpt-type-response)
823 | map)
824 | "Keymap for `chatgpt-mode'.")
825 |
826 | (defun chatgpt-mode-insert-tip ()
827 | "Insert tip to output buffer."
828 | (when (string-empty-p (buffer-string))
829 | (let ((inhibit-read-only t)
830 | (tip "Press to start asking questions
831 |
832 | `M-x chatgpt-info` will print out more information about the current session!
833 | "))
834 | (add-face-text-property 0 (length tip) 'chatgpt-tip nil tip)
835 | (insert tip))))
836 |
837 | (define-derived-mode chatgpt-mode fundamental-mode "ChatGPT"
838 | "Major mode for `chatgpt-mode'.
839 |
840 | \\"
841 | (buffer-disable-undo)
842 | (setq-local buffer-read-only t)
843 | (font-lock-mode -1)
844 | (add-hook 'kill-buffer-hook #'chatgpt-mode--kill-buffer-hook nil t)
845 | (setq-local header-line-format `((:eval (chatgpt-header-line))))
846 | (setq chatgpt-spinner (spinner-create chatgpt-spinner-type t))
847 | (setq-local chatgpt-data (ht-create))
848 | (chatgpt-mode-insert-tip))
849 |
850 | (defun chatgpt-register-instance (index buffer-or-name)
851 | "Register BUFFER-OR-NAME with INDEX as an instance.
852 |
853 | Caution, this will overwrite the existing instance!"
854 | (ht-set chatgpt-instances index (get-buffer-create buffer-or-name))
855 | (with-current-buffer buffer-or-name
856 | (chatgpt-mode)
857 | (setq chatgpt-instance (cons index (current-buffer)))))
858 |
859 | ;;;###autoload
860 | (defun chatgpt-new ()
861 | "Run a new instance of ChatGPT."
862 | (interactive)
863 | (let* ((new-index (chatgpt--new-index))
864 | (new-buffer-name (format chatgpt-buffer-name-format new-index)))
865 | (when (get-buffer new-buffer-name)
866 | (user-error "Internal Error: creating instance that already exists"))
867 | (chatgpt-register-instance new-index new-buffer-name)
868 | (chatgpt--display-buffer new-buffer-name)))
869 |
870 | ;;;###autoload
871 | (defun chatgpt ()
872 | "Start ChatGPT with existing instance, else create a new instance."
873 | (interactive)
874 | (let ((live-instances (chatgpt--live-instances))
875 | (shown-instances (chatgpt--shown-instances)))
876 | (cond (shown-instances
877 | (chatgpt--display-buffer (nth 0 shown-instances)))
878 | (live-instances
879 | (chatgpt--display-buffer (nth 0 live-instances)))
880 | (t
881 | (chatgpt-new)))))
882 |
883 | ;;;###autoload
884 | (defun chatgpt-restart ()
885 | "Restart the current ChatGPT instance."
886 | (interactive)
887 | (save-window-excursion
888 | (let ((instance
889 | (cl-case major-mode
890 | (`chatgpt-mode (current-buffer))
891 | (`chatgpt-input-mode (with-current-buffer chatgpt-input-buffer-name
892 | (cdr chatgpt-input-instance)))
893 | (`chatgpt-edit-mode (with-current-buffer chatgpt-edit-buffer-name
894 | (cdr chatgpt-edit-instance))))))
895 | (when instance
896 | (with-current-buffer instance
897 | (chatgpt--clear-side-fields)
898 | (chatgpt-restart-session))))))
899 |
900 | (provide 'chatgpt)
901 | ;;; chatgpt.el ends here
902 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
23 |