mp_core.mpsl

   1 /*
   2
   3     Minimum Profit 5.x
   4     A Programmer's Text Editor
   5
   6     Copyright (C) 1991-2009 Angel Ortega <angel@triptico.com>
   7
   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.
  12
  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.
  17
  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.
  21
  22     http://www.triptico.com
  23
  24 */
  25
  26 /** global data **/
  27
  28 /* L(x) is the same as gettext(x) */
  29 L = gettext;
  30
  31 /* LL(x) is the same as x */
  32 sub LL(x) { x; }
  33
  34 /* configuration */
  35
  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;
  47 mp.config.maximize = 0;
  48 mp.config.keep_eol = 1;
  49
  50 /* default end of line, system dependent */
  51 if (mp.drv.id eq 'win32')
  52         mp.config.eol = "\r\n";
  53 else
  54         mp.config.eol = "\n";
  55
  56 /* status line */
  57 mp.config.status_format = "%m%n %x,%y [%l] %R%O %s %e %t";
  58 mp.status_line_info = {
  59         '%V'    =>      mp.VERSION,
  60         '%m'    =>      sub { mp.active.txt.mod && '*' || ''; },
  61         '%x'    =>      sub { mp.active.txt.x + 1; },
  62         '%y'    =>      sub { mp.active.txt.y + 1; },
  63         '%l'    =>      sub { size(mp.active.txt.lines); },
  64         '%R'    =>      sub { mp.macro.process_event && 'R' || ''; },
  65         '%O'    =>      '',
  66         '%s'    =>      sub { mp.active.syntax.name; },
  67         '%t'    =>      sub { mp.tags[mp.get_word(mp.active())].label; },
  68         '%n'    =>      sub { mp.active.name; },
  69         '%w'    =>      sub { mp.word_count(mp.active()); },
  70         '%e'    =>      sub { mp.active.encoding || ''; },
  71         '%%'    =>      '%'
  72 };
  73
  74 /* a regex for selecting words */
  75 mp.word_regex = "/[[:alnum:]_]+/i";
  76
  77 /* if it does not work (i.e. not GNU regex), fall back */
  78 if (regex(mp.word_regex, "test") == NULL)
  79         mp.word_regex = '/[A-Z_][A-Z0-9_]*/i';
  80
  81 /* document list */
  82 mp.docs = [];
  83 mp.active_i = 0;
  84
  85 /* allowed color names (order matters, match the Unix curses one) */
  86 mp.color_names = [ "default", "black", "red", "green",
  87         "yellow", "blue", "magenta", "cyan", "white" ];
  88
  89 /* color definitions */
  90 mp.colors = {
  91         'normal' => {           'text'  => [ 'default', 'default' ],
  92                                 'gui'   => [ 0x000000, 0xffffff ] },
  93         'cursor' => {           'text'  => [ 'default', 'default' ],
  94                                 'gui'   => [ 0x000000, 0xffffff ],
  95                                 'flags' => [ 'reverse' ] },
  96         'selection' => {        'text'  => [ 'red', 'default' ],
  97                                 'gui'   => [ 0xff0000, 0xffffff ],
  98                                 'flags' => [ 'reverse'] },
  99         'comments' => {         'text'  => [ 'green', 'default' ],
 100                                 'gui'   => [ 0x00cc77, 0xffffff ] },
 101         'documentation' => {    'text'  => [ 'cyan', 'default' ],
 102                                 'gui'   => [ 0x8888ff, 0xffffff ] },
 103         'quotes' => {           'text'  => [ 'blue', 'default' ],
 104                                 'gui'   => [ 0x0000ff, 0xffffff ],
 105                                 'flags' => [ 'bright' ] },
 106         'matching' => {         'text'  => [ 'black', 'cyan' ],
 107                                 'gui'   => [ 0x000000, 0xffff00 ] },
 108         'word1' => {            'text'  => [ 'green', 'default' ],
 109                                 'gui'   => [ 0x00aa00, 0xffffff ],
 110                                 'flags' => [ 'bright' ] },
 111         'word2' => {            'text'  => [ 'red', 'default' ],
 112                                 'gui'   => [ 0xff6666, 0xffffff ],
 113                                 'flags' => [ 'bright' ] },
 114         'tag' => {              'text'  => [ 'cyan', 'default' ],
 115                                 'gui'   => [ 0x8888ff, 0xffffff ],
 116                                 'flags' => [ 'underline' ] },
 117         'spell' => {            'text'  => [ 'red', 'default' ],
 118                                 'gui'   => [ 0xff8888, 0xffffff ],
 119                                 'flags' => [ 'bright', 'underline' ] },
 120         'search' => {           'text'  => [ 'black', 'green' ],
 121                                 'gui'   => [ 0x000000, 0x00cc77 ] }
 122 };
 123
 124 /* hash of specially coloured words */
 125 mp.word_color = {};
 126
 127 mp.keycodes = {};
 128
 129 mp.actions = {};
 130
 131 mp.actdesc = {};
 132
 133 mp.alert_log = [];
 134
 135 /** the menu **/
 136
 137 mp.menu = [
 138         [
 139                 LL("&File"),
 140                 [ 'new', 'open', 'save', 'save_as', 'close', 'revert',
 141                         'open_under_cursor',
 142                         '-', 'hex_view',
 143                         '-', 'set_password',
 144                         '-', 'open_config_file', 'open_templates_file',
 145                         '-', 'sync',
 146                         '-', 'save_session', 'load_session',
 147                         '-', 'exit'
 148                 ]
 149         ],
 150         [
 151                 LL("&Edit"),
 152                 [ 'undo', 'redo', '-',
 153                         'cut_mark', 'copy_mark', 'paste_mark', 'delete_mark',
 154                         'delete_line', '-',
 155                         'mark', 'mark_vertical', 'unmark', '-',
 156                         'insert_template', '-',
 157                         'word_wrap_paragraph', 'join_paragraph', '-',
 158                         'exec_command', '-',
 159                         'eval', 'eval_doc'
 160                 ]
 161         ],
 162         [
 163                 LL("&Search"),
 164                 [ 'seek', 'seek_next', 'seek_prev', 'replace', '-',
 165                         'complete', '-',
 166                         'seek_misspelled', 'ignore_last_misspell', '-',
 167                         'seek_repeated_word', '-',
 168                         'find_tag', 'complete_symbol', '-', 'grep'
 169                 ]
 170         ],
 171         [
 172                 LL("&Go to"),
 173                 [ 'next', 'prev',
 174                         'move_bof', 'move_eof', 'move_bol', 'move_eol',
 175                         'goto', 'move_word_right', 'move_word_left',
 176                         'section_list',
 177                         '-', 'document_list'
 178                 ]
 179         ],
 180         [
 181                 LL("&Options"),
 182                 [ 'record_macro', 'play_macro', '-',
 183                         'encoding', 'tab_options', 'line_options', 'repeated_words_options',
 184                         'toggle_spellcheck', '-',
 185                         'word_count', '-',
 186                         'zoom_in', 'zoom_out', '-',
 187                         'about'
 188                 ]
 189         ]
 190 ];
 191
 192 mp.actions_by_menu_label = {};
 193
 194 /** code **/
 195
 196 /**
 197  * mp.redraw - Triggers a redraw on the next cycle.
 198  *
 199  * Triggers a full document redraw in the next cycle.
 200  */
 201 sub mp.redraw()
 202 {
 203         /* just increment the redraw trigger */
 204         mp.redraw_counter++;
 205 }
 206
 207
 208 sub mp.active()
 209 /* returns the active document */
 210 {
 211         local d;
 212
 213         /* empty document list? create a new, empty one */
 214         if (size(mp.docs) == 0)
 215                 mp.new();
 216
 217         /* get active document */
 218         d = mp.docs[mp.active_i];
 219
 220         /* if it's read only but has modifications, revert them */
 221         if (d.read_only && size(d.undo)) {
 222                 while (size(d.undo))
 223                         mp.undo(d);
 224
 225                 mp.message = {
 226                         'timeout'       => time() + 2,
 227                         'string'        => '*' ~ L("Read-only document") ~ '*'
 228                 };
 229         }
 230
 231         return d;
 232 }
 233
 234
 235 sub mp.process_action(a)
 236 /* processes an action */
 237 {
 238         local f, d;
 239
 240         d = mp.active();
 241
 242         if ((f = mp.actions[a]) != NULL)
 243                 f(d);
 244         else {
 245                 mp.message = {
 246                         'timeout'       => time() + 2,
 247                         'string'        => sprintf(L("Unknown action '%s'"), a)
 248                 };
 249         }
 250 }
 251
 252
 253 sub mp.process_event(k)
 254 /* processes a key event */
 255 {
 256         local d, a;
 257
 258         /* empty document list? do nothing */
 259         if (size(mp.docs) == 0)
 260                 return;
 261
 262         d = mp.active();
 263
 264         if (mp.keycodes_t == NULL)
 265                 mp.keycodes_t = mp.keycodes;
 266
 267         /* get the action asociated to the keycode */
 268         if ((a = mp.keycodes_t[k]) != NULL) {
 269
 270                 /* if it's a hash, store for further testing */
 271                 if (is_hash(a))
 272                         mp.keycodes_t = a;
 273                 else {
 274                         /* if it's executable, run it */
 275                         if (is_exec(a))
 276                                 a(d);
 277                         else
 278                         /* if it's an array, process it sequentially */
 279                         if (is_array(a))
 280                                 foreach(l, a)
 281                                         mp.process_action(l);
 282                         else
 283                                 mp.process_action(a);
 284
 285                         mp.keycodes_t = NULL;
 286                 }
 287         }
 288         else {
 289                 mp.insert_keystroke(d, k);
 290                 mp.keycodes_t = NULL;
 291         }
 292
 293         mp.shift_pressed = NULL;
 294 }
 295
 296
 297 sub mp.build_status_line()
 298 /* returns the string to be drawn in the status line */
 299 {
 300         if (mp.message) {
 301                 /* is the message still active? */
 302                 if (mp.message.timeout > time())
 303                         return mp.message.string;
 304
 305                 mp.message = NULL;
 306         }
 307
 308         return sregex("/%./g", mp.config.status_format, mp.status_line_info);
 309 }
 310
 311
 312 sub mp.backslash_codes(s, d)
 313 /* encodes (d == 0) or decodes (d == 1) backslash codes
 314    (like \n, \r, etc.) */
 315 {
 316         d &&    sregex("/[\r\n\t]/g", s, { "\r" => '\r', "\n" => '\n', "\t" => '\t'}) ||
 317                 sregex("/\\\\[rnt]/g", s, { '\r' => "\r", '\n' => "\n", '\t' => "\t"});
 318 }
 319
 320
 321 sub mp.long_op(func, a1, a2, a3, a4)
 322 /* executes a potentially long function */
 323 {
 324         local r;
 325
 326         mp.busy(1);
 327         r = func(a1, a2, a3, a4);
 328         mp.busy(0);
 329
 330         return r;
 331 }
 332
 333
 334 sub mp.get_history(key)
 335 /* returns a history for the specified key */
 336 {
 337         if (key == NULL)
 338                 return NULL;
 339         if (mp.history == NULL)
 340                 mp.history = {};
 341         if (mp.history[key] == NULL)
 342                 mp.history[key] = [];
 343
 344         return mp.history[key];
 345 }
 346
 347
 348 sub mp.menu_label(action)
 349 /* returns a label for the menu for an action */
 350 {
 351         local l;
 352
 353         /* if action is '-', it's a menu separator */
 354         if (action eq '-')
 355                 return NULL;
 356
 357         /* no recognized action? return */
 358         if (!exists(mp.actions, action))
 359                 return action ~ "?";
 360
 361         /* get the translated description */
 362         l = L(mp.actdesc[action]) || action;
 363
 364         /* is there a keycode that generates this action? */
 365         foreach (i, sort(keys(mp.keycodes))) {
 366                 if (mp.keycodes[i] eq action) {
 367                         /* avoid mouse and window pseudo-keycodes */
 368                         if (!regex("/window/", i) && !regex("/mouse/", i)) {
 369                                 l = l ~ ' [' ~ i ~ ']';
 370                                 break;
 371                         }
 372                 }
 373         }
 374
 375         mp.actions_by_menu_label[l] = action;
 376
 377         return l;
 378 }
 379
 380
 381 sub mp.trim_with_ellipsis(str, max)
 382 /* trims the string to the last max characters, adding ellipsis if done */
 383 {
 384         local v = regex('/.{' ~ max ~ '}$/', str);
 385         return v && '...' ~ v || str;
 386 }
 387
 388
 389 sub mp.get_doc_names(max)
 390 /* returns an array with the trimmed names of the documents */
 391 {
 392         map(sub(e) {
 393                 (e.txt.mod && '* ' || '') ~ mp.trim_with_ellipsis(e.name, (max || 24));
 394         }, mp.docs);
 395 }
 396
 397
 398 sub mp.usage()
 399 /* set mp.exit_message with an usage message (--help) */
 400 {
 401         mp.exit_message =
 402         sprintf(L(
 403                 "Minimum Profit %s - Programmer Text Editor\n"\
 404                 "Copyright (C) Angel Ortega <angel@triptico.com>\n"\
 405                 "This software is covered by the GPL license. NO WARRANTY.\n"\
 406                 "\n"\
 407                 "Usage: mp-5 [options] [files...]\n"\
 408                 "\n"\
 409                 "Options:\n"\
 410                 "\n"\
 411                 " -t {tag}           Edits the file where tag is defined\n"\
 412                 " -e {mpsl_code}     Executes MPSL code\n"\
 413                 " -f {mpsl_script}   Executes MPSL script file\n"\
 414                 " -d {directory}     Set current directory\n"\
 415                 " +NNN               Moves to line number NNN of last file\n"\
 416                 "\n"\
 417                 "Homepage: http://www.triptico.com/software/mp.html\n"\
 418                 "Mailing list: mp-subscribe@lists.triptico.com\n"
 419         ), mp.VERSION);
 420 }
 421
 422
 423 sub mp.process_cmdline()
 424 /* process the command line arguments (ARGV) */
 425 {
 426         local o, line;
 427
 428         mp.load_tags();
 429
 430         /* skip ARGV[0] */
 431         shift(ARGV);
 432
 433         while (o = shift(ARGV)) {
 434                 if (o eq '-h' || o eq '--help') {
 435                         mp.usage();
 436                         mp.exit();
 437                         return;
 438                 }
 439                 else
 440                 if (o eq '-e') {
 441                         /* execute code */
 442                         local c = shift(ARGV);
 443
 444                         if (! regex('/;\s*$/', c))
 445                                 c = c ~ ';';
 446
 447                         eval(c);
 448                 }
 449                 else
 450                 if (o eq '-f') {
 451                         /* execute script */
 452                         local s = shift(ARGV);
 453
 454                         if (stat(s) == NULL)
 455                                 ERROR = sprintf(L("Cannot open '%s'"), s);
 456                         else {
 457                                 mp.open(s);
 458                                 eval(join("\n", mp.active.txt.lines));
 459                                 mp.close();
 460                         }
 461                 }
 462                 else
 463                 if (o eq '-d')
 464                         chdir(shift(ARGV));
 465                 else
 466                 if (o eq '-t')
 467                         mp.open_tag(shift(ARGV));
 468                 else
 469                 if (o eq '-x') {
 470                         local s = shift(ARGV);
 471
 472                         if (mp.hex_view(s) == NULL)
 473                                 ERROR = sprintf(L("Cannot open '%s'"), s);
 474                 }
 475                 else
 476                 if (regex('/^\+/', o)) {
 477                         /* move to line */
 478                         line = o - 1;
 479                 }
 480                 else
 481                         mp.open(o);
 482         }
 483
 484         if (ERROR) {
 485                 mp.exit_message = ERROR ~ "\n";
 486                 ERROR = NULL;
 487                 mp.exit();
 488                 return;
 489         }
 490
 491         /* if no files are loaded, try a session */
 492         if (size(mp.docs) == 0 && mp.config.auto_sessions) {
 493                 mp.load_session();
 494         }
 495         else {
 496                 /* set the first as the active one */
 497                 mp.active_i = 0;
 498         }
 499
 500         mp.active();
 501
 502         /* if there is a line defined, move there */
 503         if (line != NULL)
 504                 mp.set_y(mp.active(), line);
 505 }
 506
 507
 508 sub mp.load_profile()
 509 /* loads ~/.mp.mpsl */
 510 {
 511         /* if /etc/mp.mpsl exists, execute it */
 512         if (stat('/etc/mp.mpsl') != NULL) {
 513                 eval( sub {
 514                         local INC = [ '/etc' ];
 515                         load('mp.mpsl');
 516                 });
 517         }
 518
 519         /* if ~/.mp.mpsl exists, execute it */
 520         if (ERROR == NULL && stat(HOMEDIR ~ '.mp.mpsl') != NULL) {
 521                 eval( sub {
 522                         local INC = [ HOMEDIR ];
 523                         load(".mp.mpsl");
 524                 });
 525         }
 526
 527         /* errors? show in a message */
 528         if (ERROR != NULL) {
 529                 mp.message = {
 530                         'timeout'       => time() + 20,
 531                         'string'        => ERROR
 532                 };
 533
 534                 ERROR = NULL;
 535         }
 536 }
 537
 538
 539 sub mp.setup_language()
 540 /* sets up the language */
 541 {
 542         /* set gettext() domain */
 543         gettext_domain('minimum-profit', APPDIR ~ 'locale');
 544
 545         /* test if gettext() can do a basic translation */
 546         if (gettext('&File') eq '&File' && ENV.LANG) {
 547                 /* no; try alternatives using the LANG variable */
 548                 local v = [ sregex('!/!g', ENV.LANG) ]; /* es_ES.UTF-8 */
 549                 push(v, shift(split('.', v[-1])));      /* es_ES */
 550                 push(v, shift(split('_', v[-1])));      /* es */
 551
 552                 foreach (l, v) {
 553                         eval('load("lang/' ~ l ~ '.mpsl");');
 554
 555                         if (ERROR == NULL)
 556                                 break;
 557                 }
 558
 559                 ERROR = NULL;
 560         }
 561 }
 562
 563
 564 sub mp.normalize_version(vs)
 565 /* converts a version string to something usable with cmp() */
 566 {
 567         map(sub(e) { sprintf("%03d", e); },
 568                 split('.',
 569                         sregex('/-.+$/', vs)));
 570 }
 571
 572
 573 sub mp.assert_version(found, minimal, package)
 574 /* asserts that 'found' version of 'package' is at least 'minimal',
 575    or generate a warning otherwise */
 576 {
 577         if (cmp(mp.normalize_version(found),
 578                 mp.normalize_version(minimal)) < 0) {
 579                 mp.alert(sprintf(L("WARNING: %s version found is %s, but %s is needed"),
 580                                 package, found, minimal));
 581         }
 582 }
 583
 584
 585 sub mp.test_versions()
 586 /* tests component versions */
 587 {
 588         local mpdm = MPDM();
 589
 590         mp.assert_version(mpdm.version, '1.0.7', 'MPDM');
 591         mp.assert_version(MPSL.VERSION, '1.0.7', 'MPSL');
 592 }
 593
 594
 595 /** MAIN **/
 596
 597 load("mp_drv.mpsl");
 598 load("mp_move.mpsl");
 599 load("mp_edit.mpsl");
 600 load("mp_file.mpsl");
 601 load("mp_clipboard.mpsl");
 602 load("mp_search.mpsl");
 603 load("mp_tags.mpsl");
 604 load("mp_syntax.mpsl");
 605 load("mp_macro.mpsl");
 606 load("mp_templates.mpsl");
 607 load("mp_spell.mpsl");
 608 load("mp_misc.mpsl");
 609 load("mp_crypt.mpsl");
 610 load("mp_keyseq.mpsl");
 611 load("mp_session.mpsl");
 612 load("mp_build.mpsl");
 613 load("mp_writing.mpsl");
 614
 615 mp.load_profile();
 616 mp.setup_language();
 617 mp.drv.startup();
 618 mp.process_cmdline();
 619 mp.test_versions();
 620 mp.drv.main_loop();
 621 mp.drv.shutdown();