Updated RELEASE_NOTES.
[mp-5.x.git] / mp_core.mpsl
blob41e352267ac07b8516337a1097f9e0b0e57917fe
1 /*
3     Minimum Profit 5.x
4     A Programmer's Text Editor
6     Copyright (C) 1991-2009 Angel Ortega <angel@triptico.com>
8     This program is free software; you can redistribute it and/or
9     modify it under the terms of the GNU General Public License
10     as published by the Free Software Foundation; either version 2
11     of the License, or (at your option) any later version.
13     This program is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16     GNU General Public License for more details.
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22     http://www.triptico.com
26 /** global data **/
28 /* L(x) is the same as gettext(x) */
29 L = gettext;
31 /* LL(x) is the same as x */
32 sub LL(x) { x; }
34 /* configuration */
36 mp.config = {};
37 mp.config.undo_levels = 100;
38 mp.config.word_wrap = 0;
39 mp.config.auto_indent = 0;
40 mp.config.tab_size = 8;
41 mp.config.tabs_as_spaces = 0;
42 mp.config.unlink = 1;
43 mp.config.case_sensitive_search = 1;
44 mp.config.global_replace = 0;
45 mp.config.preread_lines = 60;
46 mp.config.mark_eol = 0;
48 /* default end of line, system dependent */
49 if (mp.drv.id eq 'win32')
50         mp.config.eol = "\r\n";
51 else
52         mp.config.eol = "\n";
54 /* status line */
55 mp.config.status_format = "%m%n %x,%y [%l] %R%O %s %t";
56 mp.status_line_info = {
57         '%V'    =>      mp.VERSION,
58         '%m'    =>      sub { mp.active.txt.mod && '*' || ''; },
59         '%x'    =>      sub { mp.active.txt.x + 1; },
60         '%y'    =>      sub { mp.active.txt.y + 1; },
61         '%l'    =>      sub { size(mp.active.txt.lines); },
62         '%R'    =>      sub { mp.macro.process_event && 'R' || ''; },
63         '%O'    =>      '',
64         '%s'    =>      sub { mp.active.syntax.name; },
65         '%t'    =>      sub { mp.tags[mp.get_word(mp.active())].label; },
66         '%n'    =>      sub { mp.active.name; },
67         '%w'    =>      sub { mp.word_count(mp.active()); },
68         '%%'    =>      '%'
71 /* a regex for selecting words */
72 mp.word_regex = "/[[:alnum:]_]+/i";
74 /* if it does not work (i.e. not GNU regex), fall back */
75 if (regex(mp.word_regex, "test") == NULL)
76         mp.word_regex = '/[A-Z_][A-Z0-9_]*/i';
78 /* document list */
79 mp.docs = [];
80 mp.active_i = 0;
82 /* allowed color names (order matters, match the Unix curses one) */
83 mp.color_names = [ "default", "black", "red", "green",
84         "yellow", "blue", "magenta", "cyan", "white" ];
86 /* color definitions */
87 mp.colors = {
88         'normal' => {           'text'  => [ 'default', 'default' ],
89                                 'gui'   => [ 0x000000, 0xffffff ] },
90         'cursor' => {           'text'  => [ 'default', 'default' ],
91                                 'gui'   => [ 0x000000, 0xffffff ],
92                                 'flags' => [ 'reverse' ] },
93         'selection' => {        'text'  => [ 'red', 'default' ],
94                                 'gui'   => [ 0xff0000, 0xffffff ],
95                                 'flags' => [ 'reverse'] },
96         'comments' => {         'text'  => [ 'green', 'default' ],
97                                 'gui'   => [ 0x00cc77, 0xffffff ] },
98         'documentation' => {    'text'  => [ 'cyan', 'default' ],
99                                 'gui'   => [ 0x8888ff, 0xffffff ] },
100         'quotes' => {           'text'  => [ 'blue', 'default' ],
101                                 'gui'   => [ 0x0000ff, 0xffffff ],
102                                 'flags' => [ 'bright' ] },
103         'matching' => {         'text'  => [ 'black', 'cyan' ],
104                                 'gui'   => [ 0x000000, 0xffff00 ] },
105         'word1' => {            'text'  => [ 'green', 'default' ],
106                                 'gui'   => [ 0x00aa00, 0xffffff ],
107                                 'flags' => [ 'bright' ] },
108         'word2' => {            'text'  => [ 'red', 'default' ],
109                                 'gui'   => [ 0xff6666, 0xffffff ],
110                                 'flags' => [ 'bright' ] },
111         'tag' => {              'text'  => [ 'cyan', 'default' ],
112                                 'gui'   => [ 0x8888ff, 0xffffff ],
113                                 'flags' => [ 'underline' ] },
114         'spell' => {            'text'  => [ 'red', 'default' ],
115                                 'gui'   => [ 0xff8888, 0xffffff ],
116                                 'flags' => [ 'bright', 'underline' ] },
117         'search' => {           'text'  => [ 'black', 'green' ],
118                                 'gui'   => [ 0x000000, 0x00cc77 ] }
121 /* hash of specially coloured words */
122 mp.word_color = {};
124 mp.keycodes = {};
126 mp.actions = {};
128 mp.actdesc = {};
130 mp.alert_log = [];
132 /** the menu **/
134 mp.menu = [
135         [
136                 LL("&File"),
137                 [ 'new', 'open', 'save', 'save_as', 'close', 'revert',
138                         'open_under_cursor',
139                         '-', 'set_password',
140                         '-', 'open_config_file', 'open_templates_file',
141                         '-', 'sync',
142                         '-', 'save_session', 'load_session',
143                         '-', 'exit'
144                 ]
145         ],
146         [
147                 LL("&Edit"),
148                 [ 'undo', 'redo', '-',
149                         'cut_mark', 'copy_mark', 'paste_mark', 'delete_line', '-',
150                         'mark', 'mark_vertical', 'unmark', '-',
151                         'insert_template', '-',
152                         'word_wrap_paragraph', 'join_paragraph', '-',
153                         'exec_command', '-',
154                         'eval', 'eval_doc'
155                 ]
156         ],
157         [
158                 LL("&Search"),
159                 [ 'seek', 'seek_next', 'seek_prev', 'replace', '-',
160                         'complete', '-',
161                         'seek_misspelled', 'ignore_last_misspell', '-',
162                         'seek_repeated_word', '-',
163                         'find_tag', 'complete_symbol', '-', 'grep'
164                 ]
165         ],
166         [
167                 LL("&Go to"),
168                 [ 'next', 'prev',
169                         'move_bof', 'move_eof', 'move_bol', 'move_eol',
170                         'goto', 'move_word_right', 'move_word_left',
171                         'section_list',
172                         '-', 'document_list'
173                 ]
174         ],
175         [
176                 LL("&Options"),
177                 [ 'record_macro', 'play_macro', '-',
178                         'encoding', 'tab_options', 'line_options', 'repeated_words_options',
179                         'toggle_spellcheck', '-',
180                         'word_count', '-',
181                         'zoom_in', 'zoom_out', '-',
182                         'about'
183                 ]
184         ]
187 mp.actions_by_menu_label = {};
189 /** code **/
192  * mp.redraw - Triggers a redraw on the next cycle.
194  * Triggers a full document redraw in the next cycle.
195  */
196 sub mp.redraw()
198         /* just increment the redraw trigger */
199         mp.redraw_counter++;
203 sub mp.active()
204 /* returns the active document */
206         local d;
208         /* empty document list? create a new, empty one */
209         if (size(mp.docs) == 0)
210                 mp.new();
212         /* get active document */
213         d = mp.docs[mp.active_i];
215         /* if it's read only but has modifications, revert them */
216         if (d.read_only && size(d.undo)) {
217                 while (size(d.undo))
218                         mp.undo(d);
220                 mp.message = {
221                         'timeout'       => time() + 2,
222                         'string'        => '*' ~ L("Read-only document") ~ '*'
223                 };
224         }
226         return d;
230 sub mp.process_action(a)
231 /* processes an action */
233         local f, d;
235         d = mp.active();
237         if ((f = mp.actions[a]) != NULL)
238                 f(d);
239         else {
240                 mp.message = {
241                         'timeout'       => time() + 2,
242                         'string'        => sprintf(L("Unknown action '%s'"), a)
243                 };
244         }
248 sub mp.process_event(k)
249 /* processes a key event */
251         local d, a;
253         /* empty document list? do nothing */
254         if (size(mp.docs) == 0)
255                 return;
257         d = mp.active();
259         if (mp.keycodes_t == NULL)
260                 mp.keycodes_t = mp.keycodes;
262         /* get the action asociated to the keycode */
263         if ((a = mp.keycodes_t[k]) != NULL) {
265                 /* if it's a hash, store for further testing */
266                 if (is_hash(a))
267                         mp.keycodes_t = a;
268                 else {
269                         /* if it's executable, run it */
270                         if (is_exec(a))
271                                 a(d);
272                         else
273                         /* if it's an array, process it sequentially */
274                         if (is_array(a))
275                                 foreach(l, a)
276                                         mp.process_action(l);
277                         else
278                                 mp.process_action(a);
280                         mp.keycodes_t = NULL;
281                 }
282         }
283         else {
284                 mp.insert_keystroke(d, k);
285                 mp.keycodes_t = NULL;
286         }
288         mp.shift_pressed = NULL;
292 sub mp.build_status_line()
293 /* returns the string to be drawn in the status line */
295         if (mp.message) {
296                 /* is the message still active? */
297                 if (mp.message.timeout > time())
298                         return mp.message.string;
300                 mp.message = NULL;
301         }
303         return sregex("/%./g", mp.config.status_format, mp.status_line_info);
307 sub mp.backslash_codes(s, d)
308 /* encodes (d == 0) or decodes (d == 1) backslash codes
309    (like \n, \r, etc.) */
311         d &&    sregex("/[\r\n\t]/g", s, { "\r" => '\r', "\n" => '\n', "\t" => '\t'}) ||
312                 sregex("/\\\\[rnt]/g", s, { '\r' => "\r", '\n' => "\n", '\t' => "\t"});
316 sub mp.long_op(func, a1, a2, a3, a4)
317 /* executes a potentially long function */
319         local r;
321         mp.busy(1);
322         r = func(a1, a2, a3, a4);
323         mp.busy(0);
325         return r;
329 sub mp.get_history(key)
330 /* returns a history for the specified key */
332         if (key == NULL)
333                 return NULL;
334         if (mp.history == NULL)
335                 mp.history = {};
336         if (mp.history[key] == NULL)
337                 mp.history[key] = [];
339         return mp.history[key];
343 sub mp.menu_label(action)
344 /* returns a label for the menu for an action */
346         local l;
348         /* if action is '-', it's a menu separator */
349         if (action eq '-')
350                 return NULL;
352         /* no recognized action? return */
353         if (!exists(mp.actions, action))
354                 return action ~ "?";
356         /* get the translated description */
357         l = L(mp.actdesc[action]) || action;
359         /* is there a keycode that generates this action? */
360         foreach (i, sort(keys(mp.keycodes))) {
361                 if (mp.keycodes[i] eq action) {
362                         /* avoid mouse and window pseudo-keycodes */
363                         if (!regex("/window/", i) && !regex("/mouse/", i)) {
364                                 l = l ~ ' [' ~ i ~ ']';
365                                 break;
366                         }
367                 }
368         }
370         mp.actions_by_menu_label[l] = action;
372         return l;
376 sub mp.trim_with_ellipsis(str, max)
377 /* trims the string to the last max characters, adding ellipsis if done */
379         local v = regex('/.{' ~ max ~ '}$/', str);
380         return v && '...' ~ v || str;
384 sub mp.get_doc_names(max)
385 /* returns an array with the trimmed names of the documents */
387         map(sub(e) {
388                 (e.txt.mod && '* ' || '') ~ mp.trim_with_ellipsis(e.name, (max || 24));
389         }, mp.docs);
393 sub mp.usage()
394 /* set mp.exit_message with an usage message (--help) */
396         mp.exit_message = 
397         sprintf(L(
398                 "Minimum Profit %s - Programmer Text Editor\n"\
399                 "Copyright (C) Angel Ortega <angel@triptico.com>\n"\
400                 "This software is covered by the GPL license. NO WARRANTY.\n"\
401                 "\n"\
402                 "Usage: mp-5 [options] [files...]\n"\
403                 "\n"\
404                 "Options:\n"\
405                 "\n"\
406                 " -t {tag}           Edits the file where tag is defined\n"\
407                 " -e {mpsl_code}     Executes MPSL code\n"\
408                 " -f {mpsl_script}   Executes MPSL script file\n"\
409                 " -d {directory}     Set current directory\n"\
410                 " +NNN               Moves to line number NNN of last file\n"\
411                 "\n"\
412                 "Homepage: http://www.triptico.com/software/mp.html\n"\
413                 "Mailing list: mp-subscribe@lists.triptico.com\n"
414         ), mp.VERSION);
418 sub mp.process_cmdline()
419 /* process the command line arguments (ARGV) */
421         local o, line;
423         mp.load_tags();
425         /* skip ARGV[0] */
426         shift(ARGV);
428         while (o = shift(ARGV)) {
429                 if (o eq '-h' || o eq '--help') {
430                         mp.usage();
431                         mp.exit();
432                         return;
433                 }
434                 else
435                 if (o eq '-e') {
436                         /* execute code */
437                         local c = shift(ARGV);
439                         if (! regex('/;\s*$/', c))
440                                 c = c ~ ';';
442                         eval(c);
443                 }
444                 else
445                 if (o eq '-f') {
446                         /* execute script */
447                         local s = shift(ARGV);
449                         if (stat(s) == NULL)
450                                 ERROR = sprintf(L("Cannot open '%s'"), s);
451                         else {
452                                 mp.open(s);
453                                 eval(join("\n", mp.active.txt.lines));
454                                 mp.close();
455                         }
456                 }
457                 else
458                 if (o eq '-d')
459                         chdir(shift(ARGV));
460                 else
461                 if (o eq '-t')
462                         mp.open_tag(shift(ARGV));
463                 else
464                 if (regex('/^\+/', o)) {
465                         /* move to line */
466                         line = o - 1;
467                 }
468                 else
469                         mp.open(o);
470         }
472         if (ERROR) {
473                 mp.exit_message = ERROR ~ "\n";
474                 ERROR = NULL;
475                 mp.exit();
476                 return;
477         }
479         /* if no files are loaded, try a session */
480         if (size(mp.docs) == 0 && mp.config.auto_sessions) {
481                 mp.load_session();
482         }
483         else {
484                 /* set the first as the active one */
485                 mp.active_i = 0;
486         }
488         mp.active();
490         /* if there is a line defined, move there */
491         if (line != NULL)
492                 mp.set_y(mp.active(), line);
496 sub mp.load_profile()
497 /* loads ~/.mp.mpsl */
499         /* if /etc/mp.mpsl exists, execute it */
500         if (stat('/etc/mp.mpsl') != NULL) {
501                 eval( sub {
502                         local INC = [ '/etc' ];
503                         load('mp.mpsl');
504                 });
505         }
507         /* if ~/.mp.mpsl exists, execute it */
508         if (ERROR == NULL && stat(HOMEDIR ~ '.mp.mpsl') != NULL) {
509                 eval( sub {
510                         local INC = [ HOMEDIR ];
511                         load(".mp.mpsl");
512                 });
513         }
515         /* errors? show in a message */
516         if (ERROR != NULL) {
517                 mp.message = {
518                         'timeout'       => time() + 20,
519                         'string'        => ERROR
520                 };
522                 ERROR = NULL;
523         }
527 sub mp.setup_language()
528 /* sets up the language */
530         /* set gettext() domain */
531         gettext_domain('minimum-profit', APPDIR ~ 'locale');
533         /* test if gettext() can do a basic translation */
534         if (gettext('&File') eq '&File' && ENV.LANG) {
535                 /* no; try alternatives using the LANG variable */
536                 local v = [ sregex('!/!g', ENV.LANG) ]; /* es_ES.UTF-8 */
537                 push(v, shift(split('.', v[-1])));      /* es_ES */
538                 push(v, shift(split('_', v[-1])));      /* es */
540                 foreach (l, v) {
541                         eval('load("lang/' ~ l ~ '.mpsl");');
543                         if (ERROR == NULL)
544                                 break;
545                 }
547                 ERROR = NULL;
548         }
552 sub mp.normalize_version(vs)
553 /* converts a version string to something usable with cmp() */
555         map(sub(e) { sprintf("%03d", e); },
556                 split('.',
557                         sregex('/-.+$/', vs)));
561 sub mp.assert_version(found, minimal, package)
562 /* asserts that 'found' version of 'package' is at least 'minimal',
563    or generate a warning otherwise */
565         if (cmp(mp.normalize_version(found),
566                 mp.normalize_version(minimal)) < 0) {
567                 mp.alert(sprintf(L("WARNING: %s version found is %s, but %s is needed"),
568                                 package, found, minimal));
569         }
573 sub mp.test_versions()
574 /* tests component versions */
576         local mpdm = MPDM();
578         mp.assert_version(mpdm.version, '1.0.7', 'MPDM');
579         mp.assert_version(MPSL.VERSION, '1.0.7', 'MPSL');
583 /** MAIN **/
585 load("mp_drv.mpsl");
586 load("mp_move.mpsl");
587 load("mp_edit.mpsl");
588 load("mp_file.mpsl");
589 load("mp_clipboard.mpsl");
590 load("mp_search.mpsl");
591 load("mp_tags.mpsl");
592 load("mp_syntax.mpsl");
593 load("mp_macro.mpsl");
594 load("mp_templates.mpsl");
595 load("mp_spell.mpsl");
596 load("mp_misc.mpsl");
597 load("mp_crypt.mpsl");
598 load("mp_keyseq.mpsl");
599 load("mp_session.mpsl");
600 load("mp_build.mpsl");
601 load("mp_writing.mpsl");
603 mp.load_profile();
604 mp.setup_language();
605 mp.drv.startup();
606 mp.process_cmdline();
607 mp.test_versions();
608 mp.drv.main_loop();
609 mp.drv.shutdown();