/*
  Bitbook grammar
    April 6, 2023  by Yoshi Noda

  added menu-3-course
*/
parser grammar sequenceParser;

options { tokenVocab = sequenceLexer; }


bitmark: ( bitmark_ ( S* NL )* )+ NL* EOF ;
bitmark_: bit ;
bit:   sequence | menu_3_course ;

//
sequence:
    BitSequence format CL ( NL* bitElem )*
   |BitSequence format CL ( NL* bitElem )* NL*
       HSPL ( seqstr minusminus )* seqstr HSPL
       footer?
       ( resource (NL* resource)* )?
;
seqstr: (bitElem NL?)* s_and_w ;
minusminus:  DMM  ;
//
menu_3_course:
    BitMenu3Course format CL ( NL* bitElem )* NL*
       menu_list
       footer?
       ( resource (NL* resource)* )?

;

menu_list: hspl_slot menu_text ( HSPL menu_text )* HSPL ;

hspl_slot: HSPL ;  // needed for initialization

menu_text: melem
         | /**/
;
melem:  mtex ( mtex )* ;
mtex:   s_and_w NL*
      | (instruction|atdef|hint|example) NL*
;
footer: (NL* s_and_w)+ NL+ ;

//
bitElem:
     LIST_LINE
   | NOTBITMARK
   | dclines  // Added 12/18/2020
   | gap
   | atdef
   | reference 
   | dollarans
   | item
   | title   // 9/3/2020
   | instruction 
   | hint
   | s_and_w 
   | example
   | bool_label
   | imagebit 
   | audiobit 
   | videobit
   | articlebit
   | documentbit
   | appbit
   | websitebit
   | stillimagefilmbit  // added 8/18/2021
   | angleref     // [►]
   | anchor       // [▼]
   | bracketed_text   // added 1/21/2020
   | sp		// cuts the chained bits
;

// [_string ( ' ' string )*]
// Chained bits following don't have the space between them.
gap:
    single_gap ( single_gap|instruction|hint|item|example )*
;

single_gap:
    OPU ( NUMERIC | STRING | /*nil*/ ) (s_and_w )* clnsp
;

// item=[%1] so forth
choice_plus:  item? OPP s_and_w+ CL ;  // [+
choice_minus: item? OPM s_and_w+ CL ;  // [-
choice_star:  item? OPR s_and_w+ CL ;  // [*

resource:
      bitElem
;

//
bullet_item:
    OPBUL s_and_w CL ( atpoint )?
;

// ********************** import the common parser here*************
<<<<<<common<<<<<<
// ******************************************************************

dcolon: DBLCOLON ;

//
//lines:   ( s_and_w NL? )+ ;


s_and_w:  
	   STRING ( S+ NUMERIC )?  // string=STRING
	 | words ( S+ NUMERIC )?   // words=SENTENCE
	 | OPS s_and_w CL
	 | NUMERIC
	 | S* COLON S*
	 | '&' S* 
	 | DBLEQ | URL
;

dclines: DCANY ;

clnsp:	  CL ;  // without spaces
sspl:	  SSPL|SSPL2 ;

words:  ( SENTENCE
	| NOTBITMARK	
	| BARSTRING | ELIPSIS
	| LIST_LINE
	| AMP | Greater ~(Greater) | Less ~(Less) 
	| RightArrow | RightAngle 
	| AmpArticle | AmpDocument | AmpDocumentLink | AmpWebsite
	| AmpImage | AmpAudio | AmpVideo | AmpApp 
	| AmpArticleLink | AmpAudioLink | AmpImageLink | AmpDocumentLink
	| BitmarkMinus | BitmarkPlus
	)+ ;
sp: 	S ;


// ---------END of grammar-------------------------------------------------------------