├── LICENSE ├── README.md ├── img └── screenshot.png ├── julia-shell-emacstools.jl └── julia-shell.el /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # julia-shell-mode 2 | [![MELPA](http://melpa.org/packages/julia-shell-badge.svg)](http://melpa.org/#/julia-shell) 3 | ### Emacs major mode for an interactive [Julia](http://julialang.org/) shell 4 | ![Screenshot](./img/screenshot.png) 5 | 6 | ## Introduction 7 | 8 | `julia-shell-mode` provides a comfortable [Julia](http://julialang.org/) REPL 9 | in an interactive Emacs buffer. Some of the features include `TAB` completion 10 | through the Emacs completion system and easy interaction between a 11 | [`julia-mode`](https://github.com/JuliaLang/julia/blob/master/contrib/julia-mode.el) 12 | editing buffer and a live `julia-shell` REPL. 13 | 14 | ## Features/Usage 15 | 16 | ### Julia-shell 17 | 18 | To start a `julia-shell`, simply do 19 | 20 | ```elisp 21 | M-x run-julia 22 | ``` 23 | 24 | ### Completions 25 | 26 | To query Julia for completions of the current command on the prompt, simply hit 27 | `TAB`. This supports LaTeX substitutions, just like the native Julia shell. For 28 | example, hitting `TAB` after 29 | 30 | ```julia 31 | julia> y + \Delta 32 | ``` 33 | 34 | Completes to 35 | ```julia 36 | julia> y + Δ 37 | ``` 38 | just like in the native Julia REPL. 39 | 40 | When not substituting LaTeX letters, `julia-shell` will open a buffer with 41 | suggestions on how to complete the current command using Emacs' completion 42 | system. Simply press `TAB` to get a list of suggestions. For example, pressing 43 | `TAB` after 44 | 45 | ```julia 46 | julia> his 47 | ``` 48 | 49 | First completes to 50 | ```julia 51 | julia> hist 52 | ``` 53 | 54 | And pressing `TAB` again opens up a new `*Completions*` buffer with the 55 | following suggestions: 56 | 57 | ``` 58 | Click on a completion to select it. 59 | In this buffer, type RET to select the completion near point. 60 | 61 | Possible completions are: 62 | hist hist2D 63 | hist2d histrange 64 | ``` 65 | 66 | ### Shell interaction from `julia-mode` 67 | 68 | You can use the function `julia-shell-run-region-or-line` to send the current 69 | region to the Julia interpreter. If the region is not active, this function 70 | will send the current line. 71 | 72 | Another handy function is `julia-shell-save-and-go`: Save the current buffer 73 | and evaluate it in the Julia shell using `evalfile()`. 74 | 75 | ## Installation 76 | 77 | Put the following code in your `.emacs`, `init.el`, or equivalent: 78 | ```elisp 79 | (add-to-list 'load-path "path-to-julia-shell-mode") 80 | (require 'julia-shell) 81 | ``` 82 | where `"path-to-julia-shell-mode"` should be the location of this 83 | archive. Since the alias to `run-julia` overrides `julia-mode`'s command, make 84 | sure to include these line *after* requiring `julia-mode`. 85 | 86 | To interact with `julia-shell` from 87 | [`julia-mode`](https://github.com/JuliaLang/julia/blob/master/contrib/julia-mode.el), 88 | add the following code to your init.el: 89 | ```elisp 90 | (defun my-julia-mode-hooks () 91 | (require 'julia-shell-mode)) 92 | (add-hook 'julia-mode-hook 'my-julia-mode-hooks) 93 | (define-key julia-mode-map (kbd "C-c C-c") 'julia-shell-run-region-or-line) 94 | (define-key julia-mode-map (kbd "C-c C-s") 'julia-shell-save-and-go) 95 | ``` 96 | 97 | ## Acknowledgments 98 | 99 | This mode borrows heavily from 100 | [MATLAB-emacs](http://matlab-emacs.sourceforge.net/) and hopes to replicate the 101 | comfortable MATLAB shell experience using Julia. Thanks! 102 | 103 | Furthermore, thanks to the devs of 104 | [the original julia.el](https://github.com/JuliaLang/julia/blob/master/contrib/julia-mode.el) 105 | for laying the foundation of this, especially the neat LaTeX substitutions. 106 | 107 | ## License 108 | 109 | [GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) 110 | -------------------------------------------------------------------------------- /img/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dennisog/julia-shell-mode/583a0b2ca20461ab4356929fd0f2212c22341b69/img/screenshot.png -------------------------------------------------------------------------------- /julia-shell-emacstools.jl: -------------------------------------------------------------------------------- 1 | ## julia-shell-emacstools.jl --- Helper functions for julia-shell.el 2 | # 3 | # Author: Dennis Ogbe 4 | # 5 | ## Usage: 6 | # This file should not be modified, it is loaded from emacs on the startup of a 7 | # julia shell 8 | # 9 | ## TODO: 10 | # - precompile the module on first load? 11 | # 12 | ## License: 13 | # 14 | # Copyright (c) 2015 Dennis Ogbe 15 | # 16 | # This program is free software: you can redistribute it and/or modify 17 | # it under the terms of the GNU General Public License as published by 18 | # the Free Software Foundation, either version 2 of the License, or 19 | # (at your option) any later version. 20 | # 21 | # This program is distributed in the hope that it will be useful, 22 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 23 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 24 | # GNU General Public License for more details. 25 | # 26 | # You should have received a copy of the GNU General Public License 27 | # along with this program. If not, see . 28 | 29 | # 30 | # PART 1: The EmacsTools Module 31 | # 32 | ############################################################################### 33 | 34 | module EmacsTools 35 | 36 | export get_completions, get_latex_symbols 37 | 38 | # print completions of SUBSTRING 39 | function get_completions(substring::AbstractString) 40 | c = Base.REPLCompletions.completions(substring, length(substring)); 41 | for completion in c[1] 42 | println(completion); 43 | end 44 | end 45 | 46 | # print all available LaTeX symbols 47 | function get_latex_symbols() 48 | c = Base.REPLCompletions.latex_symbols; 49 | for (latex, unicode) in sort!(collect(c), by=x->x[2]) 50 | println("$latex $unicode") 51 | end 52 | end 53 | 54 | end # module 55 | 56 | # 57 | # PART 2: Load the EmacsTools module and do other customizations 58 | # 59 | ############################################################################### 60 | 61 | import EmacsTools 62 | -------------------------------------------------------------------------------- /julia-shell.el: -------------------------------------------------------------------------------- 1 | ;;; julia-shell.el --- Major mode for an inferior Julia shell 2 | ;; 3 | ;; Author: Dennis Ogbe 4 | ;; Package-Requires: ((julia-mode "0.3")) 5 | ;; Based on the inferior-julia part of `julia-mode.el' and functionality of 6 | ;; `matlab.el' 7 | ;; 8 | ;;; Usage: 9 | ;; Put the following code in your init.el: 10 | ;; (add-to-list 'load-path "path-to-julia-shell-mode") 11 | ;; (require 'julia-shell) 12 | ;; 13 | ;; To interact with `julia-shell' from `julia-mode', add the following code to 14 | ;; your init.el: 15 | ;; (defun my-julia-mode-hooks () 16 | ;; (require 'julia-shell-mode)) 17 | ;; (add-hook 'julia-mode-hook 'my-julia-mode-hooks) 18 | ;; (define-key julia-mode-map (kbd "C-c C-c") 'julia-shell-run-region-or-line) 19 | ;; (define-key julia-mode-map (kbd "C-c C-s") 'julia-shell-save-and-go) 20 | ;; 21 | ;;; Commentary: 22 | ;; This major mode aims to provide a comfortable julia-shell experience in 23 | ;; emacs and is inspired by Eric Ludlam's `matlab.el'. Check README.md for more 24 | ;; information. 25 | ;; 26 | ;;; TODO 27 | ;; - directory tracking 28 | ;; - maybe clean up julia-shell-run-region 29 | ;; 30 | ;;; License: 31 | ;; 32 | ;; Copyright (c) 2015 Dennis Ogbe 33 | ;; 34 | ;; This program is free software: you can redistribute it and/or modify 35 | ;; it under the terms of the GNU General Public License as published by 36 | ;; the Free Software Foundation, either version 2 of the License, or 37 | ;; (at your option) any later version. 38 | ;; 39 | ;; This program is distributed in the hope that it will be useful, 40 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 41 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 | ;; GNU General Public License for more details. 43 | ;; 44 | ;; You should have received a copy of the GNU General Public License 45 | ;; along with this program. If not, see . 46 | 47 | ;;; Code: 48 | 49 | (require 'comint) 50 | (require 'julia-mode) ;; since we're using latexsubs 51 | 52 | ;;; User-changeable variables ================================================= 53 | 54 | (defgroup julia-shell nil 55 | "Julia-shell mode." 56 | :prefix "julia-shell-" 57 | :group 'julia) 58 | 59 | (defcustom julia-shell-program "julia" 60 | "Path to the program used by `inferior-julia'." 61 | :type 'string 62 | :group 'julia-shell) 63 | 64 | (defcustom julia-shell-arguments '() 65 | "Commandline arguments to pass to `julia-shell-program'. 66 | 67 | By default, the following arguments are sent to julia: 68 | 69 | --color=no 70 | --load " 71 | :type 'string 72 | :group 'julia-shell) 73 | 74 | (defcustom julia-shell-buffer-name "*Julia*" 75 | "The name of the inferior julia-shell buffer." 76 | :type 'string 77 | :group 'julia-shell) 78 | 79 | (defcustom julia-shell-prompt-regexp "julia> " 80 | "Regexp for matching `inferior-julia' prompt." 81 | :type 'string 82 | :group 'julia-shell) 83 | 84 | (defcustom julia-shell-animate-logo t 85 | "Regexp for matching `inferior-julia' prompt." 86 | :type 'boolean 87 | :group 'julia-shell) 88 | 89 | ;;; Internal variables ======================================================== 90 | 91 | (defvar inferior-julia-shell-mode-map 92 | (let ((map (nconc (make-sparse-keymap) comint-mode-map))) 93 | (define-key map (kbd "TAB") 'julia-shell-tab) 94 | (define-key map (kbd "RET") 'julia-shell-send-input-hide-completions) 95 | (define-key map [up] 'comint-previous-input) 96 | (define-key map [down] 'comint-next-input) 97 | (define-key map [(backspace)] 'julia-shell-delete-backwards-no-prompt) 98 | map) 99 | "Basic mode map for `inferior-julia-shell-mode'.") 100 | 101 | (defvar julia-shell-latex-sub-table nil 102 | "Hashtable holding LaTeX substitions.") 103 | 104 | (defvar julia-title-ascii 105 | " _ 106 | _ _ _(_)_ 107 | (_) | (_) (_) 108 | _ _ _| |_ __ _ 109 | | | | | | | |/ _` | 110 | | | |_| | | | (_| | 111 | _/ |\\__'_|_|_|\\__'_| 112 | |__/ 113 | " 114 | "The ASCII art that gets loaded on the start of `julia-shell'.") 115 | 116 | ;;; The mode definition & startup function ==================================== 117 | 118 | (define-derived-mode inferior-julia-shell-mode comint-mode "Julia" 119 | "Major mode for `inferior-julia-shell'. 120 | 121 | \\" 122 | nil "Julia" 123 | (setq comint-prompt-regexp julia-shell-prompt-regexp) 124 | (setq comint-prompt-read-only nil) 125 | (set (make-local-variable 'font-lock-defaults) '(julia-font-lock-keywords t)) 126 | (set (make-local-variable 'paragraph-start) julia-shell-prompt-regexp) 127 | (set (make-local-variable 'indent-line-function) 'julia-indent-line)) 128 | 129 | ;;;###autoload 130 | (defun inferior-julia-shell () 131 | "Run an inferior instance of `julia' inside Emacs." 132 | (interactive) 133 | (let* ((julia-shell-program julia-shell-program) 134 | (buffer (get-buffer-create julia-shell-buffer-name)) 135 | (julia-version 136 | (shell-command-to-string (concat julia-shell-program " --version | awk '{print $3}'"))) 137 | (julia-emacsinit 138 | (expand-file-name "julia-shell-emacstools.jl" 139 | (file-name-directory (locate-library "julia-shell")))) 140 | ;; always load the julia EmacsTools using command-line arguments 141 | (julia-default-args (list "-q" "--color=no" "--load" julia-emacsinit))) 142 | (pop-to-buffer-same-window julia-shell-buffer-name) 143 | (when (not (comint-check-proc julia-shell-buffer-name)) 144 | (let ((logo-string (concat 145 | julia-title-ascii 146 | "\nA fresh approach to technical computing\n\n" 147 | "Version " julia-version "\n"))) 148 | (if julia-shell-animate-logo 149 | (animate-string logo-string 0 0) 150 | (insert logo-string))) 151 | (apply #'make-comint-in-buffer 152 | "Julia" julia-shell-buffer-name 153 | julia-shell-program 154 | nil 155 | (append julia-default-args julia-shell-arguments))) 156 | (inferior-julia-shell-mode))) 157 | 158 | ;;;###autoload 159 | (defalias 'run-julia #'inferior-julia-shell 160 | "Run an inferior instance of `julia' inside Emacs.") 161 | 162 | ;;; Helper functions ========================================================== 163 | 164 | (defun julia-shell-on-prompt-p () 165 | "Return t if on a julia prompt." 166 | (save-excursion 167 | (let ((inhibit-field-text-motion t)) 168 | (goto-char (point-max)) 169 | (beginning-of-line) 170 | (looking-at julia-shell-prompt-regexp)))) 171 | 172 | (defun julia-shell-on-empty-prompt-p () 173 | "Return t if on an empty julia prompt." 174 | (save-excursion 175 | (let ((inhibit-field-text-motion t)) 176 | (goto-char (point-max)) 177 | (beginning-of-line) 178 | (looking-at (concat julia-shell-prompt-regexp "\\s-*$"))))) 179 | 180 | (defun julia-shell-active-p () 181 | "Return t if the julia shell is active." 182 | (if (get-buffer julia-shell-buffer-name) 183 | (with-current-buffer julia-shell-buffer-name 184 | (if (comint-check-proc (current-buffer)) 185 | (current-buffer))))) 186 | 187 | (defun julia-shell-buffer-or-complain () 188 | "Return a running julia-shell buffer. Otherwise complain." 189 | (or (julia-shell-active-p) 190 | (error "There is no active Julia buffer!"))) 191 | 192 | (defun julia-shell-delete-backwards-no-prompt () 193 | "Delete one char backwards without destroying the julia prompt." 194 | (interactive) 195 | (let ((promptend (save-excursion 196 | (let ((inhibit-field-text-motion t)) 197 | (beginning-of-line) 198 | (looking-at julia-shell-prompt-regexp) 199 | (match-end 0))))) 200 | (unless (<= (point) promptend) 201 | (delete-char -1)))) 202 | 203 | (defun julia-shell-send-input-hide-completions () 204 | "Like `comint-send-input', but make sure to close any remaining completion windows." 205 | (interactive) 206 | (julia-shell-tab-hide-completions) 207 | (comint-send-input)) 208 | 209 | ;;; Julia shell interaction =================================================== 210 | 211 | (defun julia-shell-collect-command-output (command) 212 | "Collect output of COMMAND from an interactive julia shell without changing point." 213 | (let ((command-output-begin nil) 214 | (str nil) 215 | (last-cmd nil) 216 | (last-cmd-with-prompt nil) 217 | (inhibit-field-text-motion t) 218 | (julia-shell-buffer (julia-shell-buffer-or-complain))) 219 | (with-current-buffer julia-shell-buffer 220 | ;; save the last command and delete the old prompt 221 | (beginning-of-line) 222 | (setq last-cmd-with-prompt 223 | (buffer-substring (point) (line-end-position))) 224 | (setq last-cmd (replace-regexp-in-string 225 | julia-shell-prompt-regexp "" last-cmd-with-prompt)) 226 | (delete-region (point) (line-end-position)) 227 | ;; send the command 228 | (setq command-output-begin (point)) 229 | (comint-simple-send (get-buffer-process (current-buffer)) 230 | command) 231 | ;; collect the output 232 | (goto-char (point-max)) 233 | (while (not (julia-shell-on-empty-prompt-p)) 234 | (accept-process-output (get-buffer-process julia-shell-buffer)) 235 | (goto-char (point-max))) ;; we now have all of the output. 236 | ;; save output to string 237 | (forward-line -1) 238 | (setq str (buffer-substring-no-properties command-output-begin (line-end-position))) 239 | ;; delete the output from the command line 240 | (delete-region command-output-begin (point-max)) 241 | ;; restore prompt and insert last command 242 | (goto-char (point-max)) 243 | (delete-blank-lines) 244 | (beginning-of-line) 245 | (comint-send-string (get-buffer-process (current-buffer)) "\n") 246 | (insert last-cmd) 247 | ;; return the shell output 248 | str))) 249 | 250 | (defun julia-shell-get-completion-list (str) 251 | "Get a list of completions from julis, STR is the substring to complete." 252 | (let* ((julia-shell-buffer (julia-shell-buffer-or-complain)) 253 | (completion-command (concat "EmacsTools.get_completions(\"" str "\")")) 254 | (output nil) 255 | (completions nil) 256 | (bad-string-regexp "^\\\\$")) ;; a single backslash breaks things 257 | (with-current-buffer julia-shell-buffer 258 | ;; get the completions from julia 259 | (unless (string-match bad-string-regexp str) 260 | (setq output (julia-shell-collect-command-output completion-command)) 261 | ;; build a completion list, a list of lists 262 | (dolist (item (split-string output "\n")) 263 | (push (list item) completions)) 264 | ;; the last command is always a newline 265 | (nreverse (cdr completions)))))) 266 | 267 | (defun julia-shell-get-latex-symbol-table () 268 | "Return a hashtable of LaTeX symbols and their unicode counterparts." 269 | (let ((latexsub-table (make-hash-table :test 'equal)) 270 | (julia-shell-buffer (julia-shell-buffer-or-complain)) 271 | (symbol-command "EmacsTools.get_latex_symbols()") 272 | (output nil)) 273 | (with-current-buffer julia-shell-buffer 274 | (setq output (julia-shell-collect-command-output symbol-command)) 275 | (dolist (line (split-string output "\n")) 276 | (let ((table-entry nil)) 277 | (setq table-entry (split-string line)) 278 | (when (= (length table-entry) 2) 279 | (apply 'puthash (append table-entry (list latexsub-table)))))) 280 | latexsub-table))) 281 | 282 | (defvar julia-shell-window-exists-for-display-completion-flag nil 283 | "Non-nil means there was an 'other-window' available when `display-completion-list' is called.") 284 | 285 | (defun julia-shell-tab () 286 | "Suggest completions for the current command. 287 | If the command is a LaTeX symbol, replace it with its unicode character." 288 | (interactive) 289 | ;; save the old command 290 | (goto-char (point-max)) 291 | (let ((inhibit-field-text-motion t)) 292 | (beginning-of-line)) 293 | (re-search-forward julia-shell-prompt-regexp) 294 | (let* ((lastcmd (buffer-substring (point) (line-end-position))) 295 | (tempcmd lastcmd) 296 | (completions nil) 297 | (limitpos nil) 298 | (latexsub nil)) 299 | ;; search for character which limits completion, and limit command to it 300 | (setq limitpos 301 | (if (string-match ".*\\([( /[.,;=']\\)" lastcmd) 302 | (1+ (match-beginning 1)) 303 | 0)) 304 | ;; TEMPCMD will hold the LHS of a split command 305 | (if (not (eql limitpos 0)) 306 | (setq tempcmd (substring lastcmd 0 limitpos))) 307 | ;; delete the the old command 308 | (setq lastcmd (substring lastcmd limitpos)) 309 | (delete-region (+ (point) limitpos) (line-end-position)) 310 | ;; if there is a LaTeX sub, our work is done 311 | ;; note: in the future, it would be good to retrieve 312 | ;; a list of latex subs from julia on launch and build 313 | ;; the hash table in julia-shell mode. This can 314 | ;; done in the EmacsTools julia module. 315 | (setq latexsub (gethash lastcmd julia-latexsubs)) 316 | (goto-char (point-max)) 317 | (if latexsub 318 | (progn (insert latexsub) 319 | (julia-shell-tab-hide-completions)) 320 | ;; else collect the completion list 321 | ;; if we want to complete the "." operator, we want to send the left side 322 | ;; of the command to julia for completion 323 | (setq completions (julia-shell-get-completion-list 324 | (if (string-match "^.*\\.$" tempcmd) 325 | tempcmd 326 | (if (string-match "^.*[])]" lastcmd) 327 | (substring lastcmd 0 (- (length lastcmd) 1)) 328 | lastcmd)))) 329 | (goto-char (point-max)) 330 | ;; if there is only one completion, insert it right away and we're done 331 | (if (eq (length completions) 1) 332 | (progn (insert (car (car completions))) 333 | (julia-shell-tab-hide-completions)) 334 | ;; else open a completions buffer --- this (until the end of this 335 | ;; function) is taken unmodified from `matlab.el' 336 | (let ((try (try-completion lastcmd completions))) 337 | ;; Insert in a good completion. 338 | (cond ((or (eq try nil) (eq try t) 339 | (and (stringp try) 340 | (string= try lastcmd))) 341 | (insert lastcmd) 342 | ;; Before displaying the completions buffer, check to see if 343 | ;; the completions window is already displayed, or if there is 344 | ;; a next window to display. This determines how to remove the 345 | ;; completions later. 346 | (if (get-buffer-window "*Completions*") 347 | nil ;; Recycle old value of the display flag. 348 | ;; Else, reset this variable. 349 | (setq julia-shell-window-exists-for-display-completion-flag 350 | ;; Else, it isn't displayed, save an action. 351 | (if (eq (next-window) (selected-window)) 352 | ;; If there is no other window, the post action is 353 | ;; to delete. 354 | 'delete 355 | ;; If there is a window to display, the post 356 | ;; action is to bury. 357 | 'bury))) 358 | (with-output-to-temp-buffer "*Completions*" 359 | (display-completion-list (mapcar 'car completions)))) 360 | ((stringp try) 361 | (insert try) 362 | (julia-shell-tab-hide-completions)) 363 | (t 364 | (insert lastcmd)))))))) 365 | 366 | (defun julia-shell-tab-hide-completions () 367 | "Hide any completion windows for `julia-shell-tab'." 368 | (cond ((eq julia-shell-window-exists-for-display-completion-flag 'delete) 369 | (when (get-buffer "*Completions*") 370 | (delete-windows-on "*Completions*"))) 371 | ((eq julia-shell-window-exists-for-display-completion-flag 'bury) 372 | (let ((orig (selected-window)) 373 | (bw nil)) 374 | (while (setq bw (get-buffer-window "*Completions*")) 375 | (select-window bw) 376 | (bury-buffer)) 377 | (select-window orig)))) 378 | ;; Reset state. 379 | (setq julia-shell-window-exists-for-display-completion-flag nil)) 380 | 381 | ;;; Julia shell interaction from `julia-mode' ================================= 382 | 383 | (defun julia-shell-run-region (beg end) 384 | "Send the region between BEG and END to the Julia interpreter." 385 | (interactive "r") 386 | (let* ((julia-shell-buffer (julia-shell-buffer-or-complain)) 387 | (last-cmd nil) 388 | (last-cmd-with-prompt nil) 389 | (inhibit-field-text-motion t) 390 | (command 391 | (let ((str (buffer-substring-no-properties beg end))) 392 | ;; remove blank lines 393 | (while (string-match "\n\\s-*\n" str) 394 | (setq str (concat (substring str 0 (match-beginning 0)) 395 | "\n" 396 | (substring str (match-end 0))))) 397 | str))) 398 | (with-current-buffer julia-shell-buffer 399 | (if (not (julia-shell-on-prompt-p)) 400 | (error "Julia shell is busy!") 401 | ;; save the last command and delete the old prompt 402 | (beginning-of-line) 403 | (setq last-cmd-with-prompt 404 | (buffer-substring (point) (line-end-position))) 405 | (setq last-cmd (replace-regexp-in-string 406 | julia-shell-prompt-regexp "" last-cmd-with-prompt)) 407 | (delete-region (point) (line-end-position)) 408 | ;; send the command 409 | (comint-simple-send (get-buffer-process (current-buffer)) 410 | command) 411 | (goto-char (point-max)) 412 | (insert last-cmd) 413 | (goto-char (point-max)))))) 414 | 415 | (defun julia-shell-run-region-or-line () 416 | "Send the active region from BEG to END to the Julia interpreter. 417 | If region is not active, send the current line." 418 | (interactive) 419 | (if (and transient-mark-mode mark-active) 420 | (julia-shell-run-region (mark) (point)) 421 | (julia-shell-run-region (point-at-bol) (point-at-eol)))) 422 | 423 | (defun julia-shell-save-and-go () 424 | "Save this file and evaluate it in a Julia shell." 425 | (interactive) 426 | (let ((julia-shell-buffer (julia-shell-buffer-or-complain)) 427 | (filename (buffer-file-name)) 428 | (last-cmd nil) 429 | (last-cmd-with-prompt nil) 430 | (inhibit-field-text-motion t)) 431 | (save-buffer) 432 | (with-current-buffer julia-shell-buffer 433 | (if (not (julia-shell-on-prompt-p)) 434 | (error "Julia shell is busy!") 435 | (beginning-of-line) 436 | (setq last-cmd-with-prompt 437 | (buffer-substring (point) (line-end-position))) 438 | (setq last-cmd (replace-regexp-in-string 439 | julia-shell-prompt-regexp "" last-cmd-with-prompt)) 440 | (delete-region (point) (line-end-position)) 441 | (comint-simple-send (get-buffer-process (current-buffer)) 442 | (format "include(\"%s\")" filename)) 443 | (goto-char (point-max)) 444 | (insert last-cmd) 445 | (goto-char (point-max)))))) 446 | 447 | (provide 'julia-shell) 448 | ;; Local Variables: 449 | ;; coding: utf-8 450 | ;; byte-compile-warnings: (not obsolete) 451 | ;; End: 452 | ;;; julia-shell.el ends here 453 | --------------------------------------------------------------------------------