git.oblomov.eu Git - ohcount/blob - src/parsers/shell.rl

   1 // shell.rl written by Mitchell Foral. mitchell<att>caladbolg<dott>net
   2
   3 /************************* Required for every parser *************************/
   4 #ifndef OHCOUNT_SHELL_PARSER_H
   5 #define OHCOUNT_SHELL_PARSER_H
   6
   7 #include "../parser_macros.h"
   8
   9 // the name of the language
  10 const char *SHELL_LANG = LANG_SHELL;
  11
  12 // the languages entities
  13 const char *shell_entities[] = {
  14   "space", "comment", "string", "any"
  15 };
  16
  17 // constants associated with the entities
  18 enum {
  19   SHELL_SPACE = 0, SHELL_COMMENT, SHELL_STRING, SHELL_ANY
  20 };
  21
  22 /*****************************************************************************/
  23
  24 %%{
  25   machine shell;
  26   write data;
  27   include common "common.rl";
  28
  29   # Line counting machine
  30
  31   action shell_ccallback {
  32     switch(entity) {
  33     case SHELL_SPACE:
  34       ls
  35       break;
  36     case SHELL_ANY:
  37       code
  38       break;
  39     case INTERNAL_NL:
  40       std_internal_newline(SHELL_LANG)
  41       break;
  42     case NEWLINE:
  43       std_newline(SHELL_LANG)
  44     }
  45   }
  46
  47   shell_comment = '#' @comment nonnewline*;
  48
  49   shell_sq_str =
  50     '\'' @enqueue @code (
  51       newline %{ entity = INTERNAL_NL; } %shell_ccallback
  52       |
  53       ws
  54       |
  55       [^\r\n\f\t '\\] @code
  56       |
  57       '\\' nonnewline @code
  58     )* '\'' @commit;
  59   shell_dq_str =
  60     '"' @enqueue @code (
  61       newline %{ entity = INTERNAL_NL; } %shell_ccallback
  62       |
  63       ws
  64       |
  65       [^\r\n\f\t "\\] @code
  66       |
  67       '\\' nonnewline @code
  68     )* '"' @commit;
  69   # TODO: heredocs; see ruby.rl for details
  70   shell_string = shell_sq_str | shell_dq_str;
  71
  72   shell_line := |*
  73     spaces         ${ entity = SHELL_SPACE; } => shell_ccallback;
  74     shell_comment;
  75     shell_string;
  76     newline        ${ entity = NEWLINE;     } => shell_ccallback;
  77     ^space         ${ entity = SHELL_ANY;   } => shell_ccallback;
  78   *|;
  79
  80   # Entity machine
  81
  82   action shell_ecallback {
  83     callback(SHELL_LANG, shell_entities[entity], cint(ts), cint(te), userdata);
  84   }
  85
  86   shell_comment_entity = '#' nonnewline*;
  87
  88   shell_entity := |*
  89     space+               ${ entity = SHELL_SPACE;   } => shell_ecallback;
  90     shell_comment_entity ${ entity = SHELL_COMMENT; } => shell_ecallback;
  91     # TODO:
  92     ^space;
  93   *|;
  94 }%%
  95
  96 /************************* Required for every parser *************************/
  97
  98 /* Parses a string buffer with Shell code.
  99  *
 100  * @param *buffer The string to parse.
 101  * @param length The length of the string to parse.
 102  * @param count Integer flag specifying whether or not to count lines. If yes,
 103  *   uses the Ragel machine optimized for counting. Otherwise uses the Ragel
 104  *   machine optimized for returning entity positions.
 105  * @param *callback Callback function. If count is set, callback is called for
 106  *   every line of code, comment, or blank with 'lcode', 'lcomment', and
 107  *   'lblank' respectively. Otherwise callback is called for each entity found.
 108  */
 109 void parse_shell(char *buffer, int length, int count,
 110                  void (*callback) (const char *lang, const char *entity, int s,
 111                                    int e, void *udata),
 112                  void *userdata
 113   ) {
 114   init
 115
 116   %% write init;
 117   cs = (count) ? shell_en_shell_line : shell_en_shell_entity;
 118   %% write exec;
 119
 120   // if no newline at EOF; callback contents of last line
 121   if (count) { process_last_line(SHELL_LANG) }
 122 }
 123
 124 #endif
 125
 126 /*****************************************************************************/