/[svn]/linuxsampler/trunk/src/network/lscp.y

Diff of /linuxsampler/trunk/src/network/lscp.y

Parent Directory | Revision Log | View Patch Patch

-revision 2137 by schoenebeck,
Mon Oct  4 12:20:23 2010 UTC
+revision 2518 by schoenebeck,
Sat Feb  8 00:49:30 2014 UTC
 Line 3
   *   LinuxSampler - modular, streaming capable sampler                     *
   *                                                                         *
   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
-  *   Copyright (C) 2005 - 2010 Christian Schoenebeck                       *
+  *   Copyright (C) 2005 - 2014 Christian Schoenebeck                       *
   *                                                                         *
   *   This program is free software; you can redistribute it and/or modify  *
   *   it under the terms of the GNU General Public License as published by  *
 Line 35
  #include "lscpserver.h"
  #include "lscpevent.h"
  #include "lscpsymbols.h"
+ #include <algorithm>
+ #include "lscp.h"
  namespace LinuxSampler {
  // to save us typing work in the rules action definitions
  #define LSCPSERVER ((yyparse_param_t*) yyparse_param)->pServer
  #define SESSION_PARAM ((yyparse_param_t*) yyparse_param)
- #define INCREMENT_LINE { SESSION_PARAM->iLine++; SESSION_PARAM->iColumn = 0; }
+ #define INCREMENT_LINE { SESSION_PARAM->iLine++; SESSION_PARAM->iColumn = 0; sParsed.clear(); }
  // clears input buffer
  void restart(yyparse_param_t* pparam, int& yychar);
-Line 51 
 static char buf[1024]; // input buffer t
+Line 53 
 static char buf[1024]; // input buffer t
  static int bytes = 0;  // current number of characters in the input buffer
  static int ptr   = 0;  // current position in the input buffer
  static String sLastError; // error message of the last error occured
+ static String sParsed; ///< Characters of current line which have already been shifted (consumed/parsed) by the parser.
  // external reference to the function which actually reads from the socket
  extern int GetLSCPCommand( void *buf, int max_size);
-Line 64 
 inline bool isExtendedAsciiChar(const ch
+Line 67 
 inline bool isExtendedAsciiChar(const ch
      return (c < 0);
  }
+ // returns true if the given character is between between a to z.
+ inline bool isLowerCaseAlphaChar(const char c) {
+     return c >= 'a' && c <= 'z';
+ }
+ // converts the given (expected) lower case character to upper case
+ inline char alphaCharToUpperCase(const char c) {
+     return (c - 'a') + 'A';
+ }
  // custom scanner function which reads from the socket
  // (bison expects it to return the numerical ID of the next
  // "recognized token" from the input stream)
-Line 81 
 int yylex(YYSTYPE* yylval) {
+Line 94 
 int yylex(YYSTYPE* yylval) {
      const char c = buf[ptr++];
      // increment current reading position (just for verbosity / messages)
      GetCurrentYaccSession()->iColumn++;
+     sParsed += c;
      // we have to handle "normal" and "extended" ASCII characters separately
      if (isExtendedAsciiChar(c)) {
          // workaround for characters with ASCII code higher than 127
-Line 103 
 int octalsToNumber(char oct_digit0, char
+Line 117 
 int octalsToNumber(char oct_digit0, char
  }
- // we provide our own version of yyerror() so we don't have to link against the yacc library
- void yyerror(const char* s);
  using namespace LinuxSampler;
+ static std::set<String> yyExpectedSymbols();
+ /**
+  * Will be called when an error occured (usually syntax error).
+  *
+  * We provide our own version of yyerror() so we a) don't have to link against
+  * the yacc library and b) can render more helpful syntax error messages.
+  */
+ void yyerror(void* x, const char* s) {
+     yyparse_param_t* param = GetCurrentYaccSession();
+     // get the text part already parsed (of current line)
+     const bool bContainsLineFeed =
+         sParsed.find('\r') != std::string::npos ||
+         sParsed.find('\n') != std::string::npos;
+     // remove potential line feed characters
+     if (bContainsLineFeed) {
+         for (size_t p = sParsed.find('\r'); p != std::string::npos;
+              p = sParsed.find('\r')) sParsed.erase(p);
+         for (size_t p = sParsed.find('\n'); p != std::string::npos;
+              p = sParsed.find('\n')) sParsed.erase(p);
+     }
+     // start assembling the error message with Bison's own message
+     String txt = s;
+     // append exact position info of syntax error
+     txt += (" (line:"  + ToString(param->iLine+1)) +
+            (",column:" + ToString(param->iColumn)) + ")";
+     // append the part of the lined that has already been parsed
+     txt += ". Context: \"" + sParsed;
+     if (txt.empty() || bContainsLineFeed)
+         txt += "^";
+     else
+         txt.insert(txt.size() - 1, "^");
+     txt += "...\"";
+     // append the non-terminal symbols expected now/next
+     std::set<String> expectedSymbols = yyExpectedSymbols();
+     for (std::set<String>::const_iterator it = expectedSymbols.begin();
+          it != expectedSymbols.end(); ++it)
+     {
+         if (it == expectedSymbols.begin())
+             txt += " -> Should be: " + *it;
+         else
+             txt += " | " + *it;
+     }
+     dmsg(2,("LSCPParser: %s\n", txt.c_str()));
+     sLastError = txt;
+ }
  %}
  // reentrant parser
- %pure_parser
+ %pure-parser
+ %parse-param {void* yyparse_param}
+ // After entering the yyparse() function, store references to the parser's
+ // state stack, so that we can create more helpful syntax error messages than
+ // Bison (2.x) could do.
+ %initial-action {
+     yyparse_param_t* p = (yyparse_param_t*) yyparse_param;
+     p->ppStackBottom = &yyss;
+     p->ppStackTop    = &yyssp;
+ }
  // tell bison to spit out verbose syntax error messages
  %error-verbose
-Line 187 
 command               :  ADD SP add_inst
+Line 262 
 command               :  ADD SP add_inst
                        ;
  add_instruction       :  CHANNEL                               { $$ = LSCPSERVER->AddChannel();                  }
+                       |  CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index                           { $$ = LSCPSERVER->AddChannelMidiInput($5,$7);    }
+                       |  CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index  { $$ = LSCPSERVER->AddChannelMidiInput($5,$7,$9); }
                        |  DB_INSTRUMENT_DIRECTORY SP db_path    { $$ = LSCPSERVER->AddDbInstrumentDirectory($3);  }
                        |  DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename                        { $$ = LSCPSERVER->AddDbInstruments($5,$7,$9, true);        }
                        |  DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP db_path SP filename         { $$ = LSCPSERVER->AddDbInstruments($5,$9,$11, true, true); }
-Line 227 
 subscribe_event       :  AUDIO_OUTPUT_DE
+Line 304 
 subscribe_event       :  AUDIO_OUTPUT_DE
                        |  TOTAL_STREAM_COUNT                    { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_total_stream_count);   }
                        |  TOTAL_VOICE_COUNT                     { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_total_voice_count);    }
                        |  GLOBAL_INFO                           { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_global_info);          }
+                       |  EFFECT_INSTANCE_COUNT                 { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_fx_instance_count);    }
+                       |  EFFECT_INSTANCE_INFO                  { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_fx_instance_info);     }
+                       |  SEND_EFFECT_CHAIN_COUNT               { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_send_fx_chain_count);  }
+                       |  SEND_EFFECT_CHAIN_INFO                { $$ = LSCPSERVER->SubscribeNotification(LSCPEvent::event_send_fx_chain_info);   }
                        ;
  unsubscribe_event     :  AUDIO_OUTPUT_DEVICE_COUNT             { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_audio_device_count);   }
-Line 255 
 unsubscribe_event     :  AUDIO_OUTPUT_DE
+Line 336 
 unsubscribe_event     :  AUDIO_OUTPUT_DE
                        |  TOTAL_STREAM_COUNT                    { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_total_stream_count);   }
                        |  TOTAL_VOICE_COUNT                     { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_total_voice_count);    }
                        |  GLOBAL_INFO                           { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_global_info);          }
+                       |  EFFECT_INSTANCE_COUNT                 { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_fx_instance_count);    }
+                       |  EFFECT_INSTANCE_INFO                  { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_fx_instance_info);     }
+                       |  SEND_EFFECT_CHAIN_COUNT               { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_send_fx_chain_count);  }
+                       |  SEND_EFFECT_CHAIN_INFO                { $$ = LSCPSERVER->UnsubscribeNotification(LSCPEvent::event_send_fx_chain_info);   }
                        ;
  map_instruction       :  MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value { $$ = LSCPSERVER->AddOrReplaceMIDIInstrumentMapping($4,$6,$8,$10,$12,$14,$16,MidiInstrumentMapper::DONTCARE,"",$3); }
-Line 267 
 unmap_instruction     :  MIDI_INSTRUMENT
+Line 352 
 unmap_instruction     :  MIDI_INSTRUMENT
                        ;
  remove_instruction    :  CHANNEL SP sampler_channel                   { $$ = LSCPSERVER->RemoveChannel($3);                      }
+                       |  CHANNEL SP MIDI_INPUT SP sampler_channel                                           { $$ = LSCPSERVER->RemoveChannelMidiInput($5);       }
+                       |  CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index                           { $$ = LSCPSERVER->RemoveChannelMidiInput($5,$7);    }
+                       |  CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP midi_input_port_index  { $$ = LSCPSERVER->RemoveChannelMidiInput($5,$7,$9); }
                        |  MIDI_INSTRUMENT_MAP SP midi_map              { $$ = LSCPSERVER->RemoveMidiInstrumentMap($3);            }
                        |  MIDI_INSTRUMENT_MAP SP ALL                   { $$ = LSCPSERVER->RemoveAllMidiInstrumentMaps();          }
                        |  SEND_EFFECT_CHAIN SP device_index SP effect_chain  { $$ = LSCPSERVER->RemoveSendEffectChain($3,$5);     }
                        |  SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP chain_pos  { $$ = LSCPSERVER->RemoveSendEffectChainEffect($5,$7,$9); }
-                       |  FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id  { $$ = LSCPSERVER->SetFxSendEffect($5,$7,-1,-1); }
+                       |  FX_SEND SP EFFECT SP sampler_channel SP fx_send_id  { $$ = LSCPSERVER->SetFxSendEffect($5,$7,-1,-1);    }
                        |  DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path  { $$ = LSCPSERVER->RemoveDbInstrumentDirectory($5, true);  }
                        |  DB_INSTRUMENT_DIRECTORY SP db_path           { $$ = LSCPSERVER->RemoveDbInstrumentDirectory($3);        }
                        |  DB_INSTRUMENT SP db_path                     { $$ = LSCPSERVER->RemoveDbInstrument($3);                 }
-Line 344 
 set_instruction       :  AUDIO_OUTPUT_DE
+Line 432 
 set_instruction       :  AUDIO_OUTPUT_DE
                        |  FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index  { $$ = LSCPSERVER->SetFxSendAudioOutputChannel($5,$7,$9,$11); }
                        |  FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl         { $$ = LSCPSERVER->SetFxSendMidiController($5,$7,$9);              }
                        |  FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value                { $$ = LSCPSERVER->SetFxSendLevel($5,$7,$9);                       }
-                       |  FX_SEND SP SEND_EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos  { $$ = LSCPSERVER->SetFxSendEffect($5,$7,$9,$11);             }
+                       |  FX_SEND SP EFFECT SP sampler_channel SP fx_send_id SP effect_chain SP chain_pos  { $$ = LSCPSERVER->SetFxSendEffect($5,$7,$9,$11);                  }
                        |  DB_INSTRUMENT_DIRECTORY SP NAME SP db_path SP stringval_escaped                  { $$ = LSCPSERVER->SetDbInstrumentDirectoryName($5,$7);            }
                        |  DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP db_path SP stringval_escaped           { $$ = LSCPSERVER->SetDbInstrumentDirectoryDescription($5,$7);     }
                        |  DB_INSTRUMENT SP NAME SP db_path SP stringval_escaped                            { $$ = LSCPSERVER->SetDbInstrumentName($5,$7);                     }
                        |  DB_INSTRUMENT SP DESCRIPTION SP db_path SP stringval_escaped                     { $$ = LSCPSERVER->SetDbInstrumentDescription($5,$7);              }
                        |  DB_INSTRUMENT SP FILE_PATH SP filename SP filename                               { $$ = LSCPSERVER->SetDbInstrumentFilePath($5,$7);                 }
                        |  ECHO SP boolean                                                                  { $$ = LSCPSERVER->SetEcho((yyparse_param_t*) yyparse_param, $3);  }
+                       |  SHELL SP INTERACT SP boolean                                                     { $$ = LSCPSERVER->SetShellInteract((yyparse_param_t*) yyparse_param, $5); }
+                       |  SHELL SP AUTO_CORRECT SP boolean                                                 { $$ = LSCPSERVER->SetShellAutoCorrect((yyparse_param_t*) yyparse_param, $5); }
                        |  VOLUME SP volume_value                                                           { $$ = LSCPSERVER->SetGlobalVolume($3);                            }
                        |  VOICES SP number                                                                 { $$ = LSCPSERVER->SetGlobalMaxVoices($3);                         }
                        |  STREAMS SP number                                                                { $$ = LSCPSERVER->SetGlobalMaxStreams($3);                        }
-Line 441 
 buffer_size_type      :  BYTES       { $
+Line 531 
 buffer_size_type      :  BYTES       { $
  list_instruction      :  AUDIO_OUTPUT_DEVICES                               { $$ = LSCPSERVER->GetAudioOutputDevices();              }
                        |  MIDI_INPUT_DEVICES                                 { $$ = LSCPSERVER->GetMidiInputDevices();                }
                        |  CHANNELS                                           { $$ = LSCPSERVER->ListChannels();                       }
+                       |  CHANNEL SP MIDI_INPUTS SP sampler_channel          { $$ = LSCPSERVER->ListChannelMidiInputs($5);            }
                        |  AVAILABLE_ENGINES                                  { $$ = LSCPSERVER->ListAvailableEngines();               }
                        |  AVAILABLE_EFFECTS                                  { $$ = LSCPSERVER->ListAvailableEffects();               }
                        |  EFFECT_INSTANCES                                   { $$ = LSCPSERVER->ListEffectInstances();                }
-Line 842 
 REMOVE                :  'R''E''M''O''V'
+Line 933 
 REMOVE                :  'R''E''M''O''V'
  SET                   :  'S''E''T'
                        ;
+ SHELL                 :  'S''H''E''L''L'
+                       ;
+ INTERACT              :  'I''N''T''E''R''A''C''T'
+                       ;
+ AUTO_CORRECT          :  'A''U''T''O''_''C''O''R''R''E''C''T'
+                       ;
  APPEND                :  'A''P''P''E''N''D'
                        ;
-Line 950 
 TOTAL_VOICE_COUNT_MAX:  'T''O''T''A''L''
+Line 1050 
 TOTAL_VOICE_COUNT_MAX:  'T''O''T''A''L''
  GLOBAL_INFO          :  'G''L''O''B''A''L''_''I''N''F''O'
                       ;
+ EFFECT_INSTANCE_COUNT   :  'E''F''F''E''C''T''_''I''N''S''T''A''N''C''E''_''C''O''U''N''T'
+                         ;
+ EFFECT_INSTANCE_INFO    :  'E''F''F''E''C''T''_''I''N''S''T''A''N''C''E''_''I''N''F''O'
+                         ;
+ SEND_EFFECT_CHAIN_COUNT :  'S''E''N''D''_''E''F''F''E''C''T''_''C''H''A''I''N''_''C''O''U''N''T'
+                         ;
+ SEND_EFFECT_CHAIN_INFO  :  'S''E''N''D''_''E''F''F''E''C''T''_''C''H''A''I''N''_''I''N''F''O'
+                         ;
  INSTRUMENT           :  'I''N''S''T''R''U''M''E''N''T'
                       ;
-Line 1010 
 EFFECT_INSTANCE_INPUT_CONTROL :  'E''F''
+Line 1122 
 EFFECT_INSTANCE_INPUT_CONTROL :  'E''F''
  SEND_EFFECT_CHAIN :  'S''E''N''D''_''E''F''F''E''C''T''_''C''H''A''I''N'
                    ;
- SEND_EFFECT  :  'S''E''N''D''_''E''F''F''E''C''T'
-              ;
  SEND_EFFECT_CHAINS :  'S''E''N''D''_''E''F''F''E''C''T''_''C''H''A''I''N''S'
                     ;
-Line 1061 
 MIDI_INPUT_TYPE       :  'M''I''D''I''_'
+Line 1170 
 MIDI_INPUT_TYPE       :  'M''I''D''I''_'
  MIDI_INPUT            :  'M''I''D''I''_''I''N''P''U''T'
                        ;
+ MIDI_INPUTS           :  'M''I''D''I''_''I''N''P''U''T''S'
+                       ;
  MIDI_CONTROLLER       :  'M''I''D''I''_''C''O''N''T''R''O''L''L''E''R'
                        ;
-Line 1171 
 QUIT                  :  'Q''U''I''T'
+Line 1283 
 QUIT                  :  'Q''U''I''T'
  %%
+ // TODO: actually would be fine to have the following bunch of source code in a separate file, however those functions are a) accessing private Bison tables like yytable and b) including the functions from another file here would make the line numbers incorrect on compile errors in auto generated lscpparser.cpp
  /**
-  * Will be called when an error occured (usually syntax error).
+  * Additional informations of a grammar symbol.
+  */
+ struct BisonSymbolInfo {
+     bool isTerminalSymbol; ///< Whether the symbol is a terminal or non-termianl symbol. NOTE: Read comment regarding this in _isRuleTerminalSymbol() !!
+     String nextExpectedChars; ///< According to current parser position: sequence of characters expected next for satisfying this grammar symbol.
+ };
+ #if HAVE_BISON_MAJ >= 3 // Bison 3.x or younger ...
+ /**
+  * Must ONLY be called just before a so called "reduce" parser action:
+  * Returns true if the grammar rule, which is just about to be "reduced", is a
+  * terminal symbol (in *our* terms).
+  *
+  * Please note that the term "terminal symbol" is a bit confusingly used in
+  * this source code here around. In Bison's terms, "terminal symbols" are (more
+  * or less) just the numbers returned by the YYLEX function. Since we decided
+  * though to use a convenient solution without a separate lexer, and all its
+  * caveats, all numbers by the yylex() function here are just the ASCII
+  * numbers of the individual characters received. Based on that however, one
+  * single character is not what one would intuitively expect of being a
+  * "terminal symbol", because it is simply too primitive.
+  *
+  * So in this LSCP parser source code a "terminal symbol" rather means a
+  * keyword like "CREATE" or "GET". In the grammal definition above, those are
+  * however defined as grammar rules (non-terminals in Bison's terms). So this
+  * function decides like this: if the given grammar rule just contains
+  * individual characters on the right side of its grammar rule, then it is a
+  * "terminal symbol" in *our* terms.
+  *
+  * @param rule - Bison grammar rule number
+  * @param stack - reflecting current Bison parser state
+  */
+ inline static bool _isRuleTerminalSymbol(int rule, const std::vector<YYTYPE_INT16>& stack) {
+     int nrhs = yyr2[rule];
+     for (int i = 0; i < nrhs; ++i)
+         if (yystos[*(stack.end() - nrhs + i)] >= YYNTOKENS) return false;
+     return true;
+ }
+ /**
+  * Must ONLY be called just before a so called "reduce" parser action: Returns
+  * additional informations to the given grammar rule that is about to be
+  * "reduced".
+  *
+  * @param rule - Bison grammar rule number
+  * @param stack - reflecting current Bison parser state
+  * @param nextExpectedChars - must already be filled with the characters
+  *                            expected to be coming next
+  */
+ inline static BisonSymbolInfo _symbolInfoForRule(int rule, const std::vector<YYTYPE_INT16>& stack, const String& nextExpectedChars) {
+     BisonSymbolInfo info;
+     info.isTerminalSymbol = _isRuleTerminalSymbol(rule, stack);
+     if (info.isTerminalSymbol) info.nextExpectedChars  = nextExpectedChars;
+     return info;
+ }
+ #else // Bison 2.x or older ...
+ /**
+  * Returns true if the given grammar @a rule is a terminal symbol (in *our*
+  * terms).
+  *
+  * Please note that the term "terminal symbol" is a bit confusingly used in
+  * this source code here around. In Bison's terms, "terminal symbols" are (more
+  * or less) just the numbers returned by the YYLEX function. Since we decided
+  * though to use a convenient solution without a separate lexer, and all its
+  * caveats, all numbers by the yylex() function here are just the ASCII
+  * numbers of the individual characters received. Based on that however, one
+  * single character is not what one would intuitively expect of being a
+  * "terminal symbol", because it is simply too primitive.
+  *
+  * So in this LSCP parser source code a "terminal symbol" rather means a
+  * keyword like "CREATE" or "GET". In the grammal definition above, those are
+  * however defined as grammar rules (non-terminals in Bison's terms). So this
+  * function decides like this: if the given grammar rule just contains
+  * individual characters on the right side of its grammar rule, then it is a
+  * "terminal symbol" in *our* terms.
+  *
+  * @param rule - Bison grammar rule number
+  */
+ inline static bool _isRuleTerminalSymbol(int rule) {
+     for (int i = yyprhs[rule]; yyrhs[i] != -1; ++i)
+         if (yyrhs[i] >= YYNTOKENS) return false;
+     return true;
+ }
+ /**
+  * Returns additional informations to the given grammar @a rule.
+  *
+  * @param rule - grammar rule index to retrieve informations about
+  * @param nextExpectedChars - must already be filled with the characters
+  *                            expected to be coming next
+  */
+ inline static BisonSymbolInfo _symbolInfoForRule(int rule, const String& nextExpectedChars) {
+     BisonSymbolInfo info;
+     info.isTerminalSymbol = _isRuleTerminalSymbol(rule);
+     if (info.isTerminalSymbol) info.nextExpectedChars  = nextExpectedChars;
+     return info;
+ }
+ #endif // HAVE_BISON_MAJ >= 3
+ /**
+  * Returns the human readable name of the given @a token.
+  */
+ inline static String _tokenName(int token) {
+     String s = yytname[token];
+     // remove leading and trailing apostrophes that Bison usually adds to
+     // ASCII characters used directly in grammar rules
+     if (s.empty()) return s;
+     if (s[0] == '\'') s.erase(0, 1);
+     if (s.empty()) return s;
+     if (s[s.size() - 1] == '\'') s.erase(s.size() - 1);
+     return s;
+ }
+ #define DEBUG_BISON_SYNTAX_ERROR_WALKER 0
+ /**
+  * Tries to find the next expected grammar symbols according to the given
+  * precise parse position & state represented by @a stack, according to Bison's
+  * LALR(1) parser algorithm.
+  *
+  * This function is given a Bison parser state stack, reflecting the parser's
+  * entire state at a certain point, i.e. when a syntax error occured. This
+  * function will then walk ahead the potential parse tree starting from the
+  * current head of the given state stack. This function will call itself
+  * recursively to scan the individual parse tree branches. As soon as it hits
+  * on the next non-terminal grammar symbol in one parse tree branch, it adds the
+  * found non-terminal symbol to @a expectedSymbols and aborts scanning the
+  * respective tree branch further. If any local parser state is reached a second
+  * time, the respective parse tree is aborted to avoid any endless recursion.
+  *
+  * @param stack - current Bison (yacc) state stack to be examined
+  * @param expectedSymbols - will be filled with next expected grammar symbols
+  * @param nextExpectedChars - just for internal purpose, due to the recursive
+  *                            implementation of this function, do supply an
+  *                            empty character for this argument
+  * @param depth - just for internal debugging purposes
   */
- void yyerror(const char* s) {
+ static void walkAndFillExpectedSymbols(
+     std::vector<YYTYPE_INT16>& stack,
+     std::map<String,BisonSymbolInfo>& expectedSymbols,
+     String& nextExpectedChars, int depth = 0)
+ {
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+     printf("\n");
+     for (int i = 0; i < depth; ++i) printf("\t");
+     printf("State stack:");
+     for (int i = 0; i < stack.size(); ++i) {
+         printf(" %d", stack[i]);
+     }
+     printf("\n");
+ #endif
+     if (stack.empty()) return;
+     int state = stack[stack.size() - 1];
+     int n = yypact[state];
+     if (n == YYPACT_NINF) { // default reduction required ...
+         // get default reduction rule for this state
+         n = yydefact[state];
+         if (n <= 0 || n >= YYNRULES) return; // no rule, something is wrong
+         // return the new resolved expected symbol (left-hand symbol of grammar
+         // rule), then we're done in this state
+         #if HAVE_BISON_MAJ >= 3
+         expectedSymbols[yytname[yyr1[n]]] = _symbolInfoForRule(n, stack, nextExpectedChars);
+         #else
+         expectedSymbols[yytname[yyr1[n]]] = _symbolInfoForRule(n, nextExpectedChars);
+         #endif
+         return;
+     }
+     if (!(YYPACT_NINF < n && n <= YYLAST)) return;
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+     for (int i = 0; i < depth; ++i) printf("\t");
+     printf("Expected tokens:");
+ #endif
+     int begin = n < 0 ? -n : 0;
+     int checklim = YYLAST - n + 1;
+     int end = checklim < YYNTOKENS ? checklim : YYNTOKENS;
+     int rule, action, stackSize, nextExpectedCharsLen;
+     for (int token = begin; token < end; ++token) {
+         if (token == YYTERROR || yycheck[n + token] != token) continue;
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+         printf(" %s", yytname[token]);
+ #endif
+         //if (yycheck[n + token] != token) goto default_reduction;
+         action = yytable[n + token];
+         if (action == 0 || action == YYTABLE_NINF) {
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+             printf(" (invalid action) "); fflush(stdout);
+ #endif
+             continue; // error, ignore
+         }
+         if (action < 0) { // reduction with rule -action required ...
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+             printf(" (reduction) "); fflush(stdout);
+ #endif
+             rule = -action;
+             goto reduce;
+         }
+         if (action == YYFINAL) continue; // "accept" state, we don't care about it here
+         // "shift" required ...
+         if (std::find(stack.begin(), stack.end(), action) != stack.end())
+             continue; // duplicate state, ignore it to avoid endless recursions
+         // "shift" / push the new state on the state stack and call this
+         // function recursively, and restore the stack after the recurse return
+         stackSize = stack.size();
+         nextExpectedCharsLen = nextExpectedChars.size();
+         stack.push_back(action);
+         nextExpectedChars += _tokenName(token);
+         walkAndFillExpectedSymbols( //FIXME: could cause stack overflow (should be a loop instead), is probably fine with our current grammar though
+             stack, expectedSymbols, nextExpectedChars, depth + 1
+         );
+         stack.resize(stackSize); // restore stack
+         nextExpectedChars.resize(nextExpectedCharsLen); // restore 'nextExpectedChars'
+         continue;
+     //default_reduction: // resolve default reduction for this state
+     //    printf(" (default red.) "); fflush(stdout);
+     //    rule = yydefact[state];
+     reduce: // "reduce" required
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+         printf(" (reduce by %d) ", rule); fflush(stdout);
+ #endif
+         if (rule == 0 || rule >= YYNRULES) continue; // invalid rule, something is wrong
+         // store the left-hand symbol of the grammar rule
+         #if HAVE_BISON_MAJ >= 3
+         expectedSymbols[yytname[yyr1[rule]]] = _symbolInfoForRule(rule, stack, nextExpectedChars);
+         #else
+         expectedSymbols[yytname[yyr1[rule]]] = _symbolInfoForRule(rule, nextExpectedChars);
+         #endif
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+         printf(" (SYM %s) ", yytname[yyr1[rule]]); fflush(stdout);
+ #endif
+     }
+ #if DEBUG_BISON_SYNTAX_ERROR_WALKER
+     printf("\n");
+ #endif
+ }
+ /**
+  * Implements Bison's so called "reduce" action, according to Bison's LALR(1)
+  * parser algorithm.
+  */
+ inline static int _yyReduce(std::vector<YYTYPE_INT16>& stack, const int& rule) {
+     if (stack.empty()) throw 1; // severe error
+     const int len = yyr2[rule];
+     stack.resize(stack.size() - len);
+     YYTYPE_INT16 newState = yypgoto[yyr1[rule] - YYNTOKENS] + stack.back();
+     if (0 <= newState && newState <= YYLAST && yycheck[newState] == stack.back())
+         newState = yytable[newState];
+     else
+         newState = yydefgoto[yyr1[rule] - YYNTOKENS];
+     stack.push_back(newState);
+     return newState;
+ }
+ /**
+  * Implements Bison's so called "default reduce" action, according to Bison's
+  * LALR(1) parser algorithm.
+  */
+ inline static int _yyDefaultReduce(std::vector<YYTYPE_INT16>& stack) {
+     if (stack.empty()) throw 2; // severe error
+     int rule = yydefact[stack.back()];
+     if (rule <= 0 || rule >= YYNRULES) throw 3; // no rule, something is wrong
+     return _yyReduce(stack, rule);
+ }
+ #define DEBUG_PUSH_PARSE 0
+ /**
+  * Implements parsing exactly one character (given by @a c), continueing at the
+  * parser position reflected by @a stack. The @a stack will hold the new parser
+  * state after this call.
+  *
+  * This function is implemented according to Bison's LALR(1) parser algorithm.
+  */
+ static bool yyPushParse(std::vector<YYTYPE_INT16>& stack, char ch) {
+     startLabel:
+ #if DEBUG_PUSH_PARSE
+     //printf("\n");
+     //for (int i = 0; i < depth; ++i) printf("\t");
+     printf("State stack:");
+     for (int i = 0; i < stack.size(); ++i) {
+         printf(" %d", stack[i]);
+     }
+     printf(" char='%c'(%d)\n", ch, (int)ch);
+ #endif
+     if (stack.empty()) return false;
+     int state = stack.back();
+     int n = yypact[state];
+     if (n == YYPACT_NINF) { // default reduction required ...
+ #if DEBUG_PUSH_PARSE
+         printf("(def reduce 1)\n");
+ #endif
+         state = _yyDefaultReduce(stack);
+         goto startLabel;
+     }
+     if (!(YYPACT_NINF < n && n <= YYLAST)) return false;
+     YYTYPE_INT16 token = (ch == YYEOF) ? YYEOF : yytranslate[ch];
+     n += token;
+     if (n < 0 || YYLAST < n || yycheck[n] != token) {
+ #if DEBUG_PUSH_PARSE
+         printf("(def reduce 2) n=%d token=%d\n", n, token);
+ #endif
+         state = _yyDefaultReduce(stack);
+         goto startLabel;
+     }
+     int action = yytable[n]; // yytable[yypact[state] + token]
+     if (action == 0 || action == YYTABLE_NINF) throw 4;
+     if (action < 0) {
+ #if DEBUG_PUSH_PARSE
+         printf("(reduce)\n");
+ #endif
+         int rule = -action;
+         state = _yyReduce(stack, rule);
+         goto startLabel;
+     }
+     if (action == YYFINAL) return true; // final state reached
+ #if DEBUG_PUSH_PARSE
+     printf("(push)\n");
+ #endif
+     // push new state
+     state = action;
+     stack.push_back(state);
+     return true;
+ }
+ /**
+  * Returns true if parsing ahead with given character @a ch is syntactially
+  * valid according to the LSCP grammar, it returns false if it would create a
+  * parse error.
+  *
+  * This is just a wrapper ontop of yyPushParse() which converts parser
+  * exceptions thrown by yyPushParse() into negative return value.
+  */
+ static bool yyValid(std::vector<YYTYPE_INT16>& stack, char ch) {
+     try {
+         return yyPushParse(stack, ch);
+     } catch (int i) {
+ #if DEBUG_PUSH_PARSE
+         printf("exception %d\n", i);
+ #endif
+         return false;
+     } catch (...) {
+         return false;
+     }
+ }
+ /**
+  * Returns the amount of correct characters of given @a line from the left,
+  * according to the LSCP grammar.
+  *
+  * @param stack - a Bison symbol state stack to work with
+  * @param line  - the input line to check
+  * @param bAutoCorrect - if true: try to correct obvious, trivial syntax errors
+  */
+ static int yyValidCharacters(std::vector<YYTYPE_INT16>& stack, String& line, bool bAutoCorrect) {
+     int i;
+     for (i = 0; i < line.size(); ++i) {
+         // since we might check the same parser state twice against the current
+         // char here below, and since the state stack might be altered
+         // (i.e. shifted or reduced) on syntax errors, we have to backup the
+         // current state stack and restore it on syntax errors below
+         std::vector<YYTYPE_INT16> stackBackup = stack;
+         if (yyValid(stackBackup, line[i])) {
+             stack = stackBackup;
+             continue;
+         }
+         if (bAutoCorrect) {
+             // try trivial corrections, i.e. upper case character instead of
+             // lower case, subline instead of space and vice versa
+             char c;
+             if      (line[i] == ' ') c = '_';
+             else if (line[i] == '_') c = ' ';
+             else if (isLowerCaseAlphaChar(line[i]))
+                 c = alphaCharToUpperCase(line[i]);
+             else return i;
+             if (yyValid(stack, c)) {
+                 line[i] = c;
+                 continue;
+             }
+         }
+         return i;
+     }
+     return i;
+ }
+ /**
+  * Should only be called on syntax errors: returns a set of non-terminal
+  * symbols expected to appear now/next, just at the point where the syntax
+  * error appeared.
+  */
+ static std::set<String> yyExpectedSymbols() {
+     std::map<String,BisonSymbolInfo> expectedSymbols;
      yyparse_param_t* param = GetCurrentYaccSession();
-     String msg = s
+     YYTYPE_INT16* ss = (*param->ppStackBottom);
-         + (" (line:"   + ToString(param->iLine+1))
+     YYTYPE_INT16* sp = (*param->ppStackTop);
-         + ( ",column:" + ToString(param->iColumn))
+     int iStackSize   = sp - ss + 1;
-         + ")";
+     // copy and wrap parser's state stack into a convenient STL container
-     dmsg(2,("LSCPParser: %s\n", msg.c_str()));
+     std::vector<YYTYPE_INT16> stack;
-     sLastError = msg;
+     for (int i = 0; i < iStackSize; ++i) {
+         stack.push_back(ss[i]);
+     }
+     String notUsedHere;
+     // do the actual parser work
+     walkAndFillExpectedSymbols(stack, expectedSymbols, notUsedHere);
+     // convert expectedSymbols to the result set
+     std::set<String> result;
+     for (std::map<String,BisonSymbolInfo>::const_iterator it = expectedSymbols.begin();
+          it != expectedSymbols.end(); ++it) result.insert(it->first);
+     return result;
  }
  namespace LinuxSampler {
+ #define DEBUG_SHELL_INTERACTION 0
+ /**
+  * If LSP shell mode is enabled, then this function is called on every new
+  * received from client. It will check the current total input line and reply
+  * to the LSCP shell for providing colored syntax highlighting and potential
+  * auto completion in the shell.
+  *
+  * It also performs auto correction of obvious & trivial syntax mistakes if
+  * requested.
+  */
+ String lscpParserProcessShellInteraction(String& line, yyparse_param_t* param) {
+     // first, determine how many characters (starting from the left) of the
+     // given input line are already syntactially correct
+     std::vector<YYTYPE_INT16> stack;
+     stack.push_back(0); // every Bison symbol stack starts with state zero
+     String l = line + '\n'; // '\n' to pretend ENTER as if the line was now complete
+     int n = yyValidCharacters(stack, l, param->bShellAutoCorrect);
+     // if auto correction is enabled, apply the auto corrected string to
+     // intput/output string 'line'
+     if (param->bShellAutoCorrect) {
+         int nMin = (n < line.length()) ? n : line.length();
+         line.replace(0, nMin, l.substr(0, nMin));
+     }
+     // generate an info string that will be sent to the LSCP shell for letting
+     // it know which part is correct, which one is wrong, where is the cursor, etc.
+     String result = line;
+     result.insert(n <= result.length() ? n : result.length(), LSCP_SHK_GOOD_FRONT);
+     int code = (n > line.length()) ? LSCP_SHU_COMPLETE : (n < line.length()) ?
+                LSCP_SHU_SYNTAX_ERR : LSCP_SHU_INCOMPLETE;
+     result = "SHU:" + ToString(code) + ":" + result + LSCP_SHK_CURSOR;
+     //if (n > line.length()) result += " [OK]";
+     // get a clean parser stack to the last valid parse position
+     // (due to the appended '\n' character above, and on syntax errors, the
+     // state stack might be in undesired, i.e. reduced state)
+     stack.clear();
+     stack.push_back(0); // every Bison symbol stack starts with state zero
+     l = line.substr(0, n);
+     if (!l.empty()) yyValidCharacters(stack, l, param->bShellAutoCorrect);
+     // generate auto completion suggestion (based on the current parser stack)
+     std::map<String,BisonSymbolInfo> expectedSymbols;
+     String notUsedHere;
+     walkAndFillExpectedSymbols(stack, expectedSymbols, notUsedHere);
+     if (expectedSymbols.size() == 1) {
+         String name          = expectedSymbols.begin()->first;
+         BisonSymbolInfo info = expectedSymbols.begin()->second;
+ #if DEBUG_SHELL_INTERACTION
+         printf("Suggested Completion (%d): %s '%s'\n", expectedSymbols.size(), (info.isTerminalSymbol) ? "T:" : "NT:", (name + " (" + info.nextExpectedChars + ")").c_str());
+ #endif
+         result += LSCP_SHK_SUGGEST_BACK + info.nextExpectedChars;
+     } else if (expectedSymbols.size() == 0) {
+ #if DEBUG_SHELL_INTERACTION
+         printf("No suggestion.\n");
+ #endif
+     } else if (expectedSymbols.size() > 1) {
+ #if DEBUG_SHELL_INTERACTION
+         printf("Multiple possibilities:");
+         for (std::map<String,BisonSymbolInfo>::const_iterator it = expectedSymbols.begin();
+              it != expectedSymbols.end(); ++it)
+         {
+             printf(" %s (..%s)", it->first.c_str(), it->second.nextExpectedChars.c_str());
+         }
+         printf("\n");
+ #endif
+         // check if any of the possibilites is a non-terminal symbol, if so, we
+         // have no way for auto completion at this point
+         bool bNonTerminalExists = false;
+         for (std::map<String,BisonSymbolInfo>::const_iterator it = expectedSymbols.begin();
+              it != expectedSymbols.end(); ++it) if (!it->second.isTerminalSymbol) { bNonTerminalExists = true; break; };
+         if (!bNonTerminalExists) {
+             // all possibilites are terminal symbaols, so try to find the least
+             // common string all possibilites start with from the left
+             String sCommon;
+             for (int i = 0; true; ++i) {
+                 char c;
+                 for (std::map<String,BisonSymbolInfo>::const_iterator it = expectedSymbols.begin();
+                      it != expectedSymbols.end(); ++it)
+                 {
+                     if (i >= it->second.nextExpectedChars.size())
+                         goto commonSearchEndLabel;
+                     if (it == expectedSymbols.begin())
+                         c = it->second.nextExpectedChars[i];
+                     if (c != it->second.nextExpectedChars[i])
+                         goto commonSearchEndLabel;
+                     if (it == --expectedSymbols.end())
+                         sCommon += c;
+                 }
+             }
+             commonSearchEndLabel:
+             if (!sCommon.empty()) result += LSCP_SHK_SUGGEST_BACK + sCommon;
+ #if DEBUG_SHELL_INTERACTION
+             printf("Common possibility: '%s'\n", sCommon.c_str());
+ #endif
+         }
+     }
+ #if DEBUG_SHELL_INTERACTION
+     printf("%s\n", result.c_str());
+ #endif
+     return result;
+ }
  /**
   * Clears input buffer.
   */
-Line 1193 
 void restart(yyparse_param_t* pparam, in
+Line 1831 
 void restart(yyparse_param_t* pparam, in
      bytes = 0;
      ptr   = 0;
      sLastError = "";
+     sParsed = "";
  }
  }

 Legend:



Removed from v.2137
 


changed lines


 
Added in v.2518
 Legend:



Removed from v.2137
 


changed lines


 
Added in v.2518
-Removed from v.2137
+Added in v.2518

	ViewVC Help
Powered by ViewVC