/********************************************************************************
*                                                                               *
*                   S y n t a x   H i g h l i g h t   E n g i n e               *
*                                                                               *
*********************************************************************************
* Copyright (C) 2002,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* 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          *
* the Free Software Foundation, either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This program is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                 *
* GNU General Public License for more details.                                  *
*                                                                               *
* You should have received a copy of the GNU General Public License             *
* along with this program.  If not, see <http://www.gnu.org/licenses/>.         *
********************************************************************************/
#ifndef SYNTAX_H
#define SYNTAX_H

class Rule;
class Syntax;


// List of syntax rules
typedef FXPtrListOf<Rule> RuleList;


// List of syntaxes
typedef FXPtrListOf<Syntax> SyntaxList;


// Highlight node
class Rule {
  friend class Syntax;
protected:
  FXString      name;           // Name of rule
  FXString      style;          // Colors for highlighting (default)
  RuleList      rules;          // Subrules
  FXival        parent;         // Parent rule
  FXival        index;          // Own style index
protected:
  Rule(){}
private:
  Rule(const Rule&);
  Rule &operator=(const Rule&);
public:

  // Construct node
  Rule(const FXString& nam,const FXString& sty,FXival par,FXival idx);

  // Set rule name
  void setName(const FXString& nm){ name=nm; }

  // Get rule name
  const FXString& getName() const { return name; }

  // Set style name
  void setStyle(const FXString& st){ style=st; }

  // Get style name
  const FXString& getStyle() const { return style; }

  // Get parent index
  FXival getParent() const { return parent; }

  // Get style index
  FXival getIndex() const { return index; }

  // Get number of child rules
  FXival getNumRules() const { return rules.no(); }

  // Get child rule
  Rule* getRule(FXival inx) const { return rules[inx]; }

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~Rule();
  };


// Default highlight node
class DefaultRule : public Rule {
protected:
  DefaultRule(){ }
private:
  DefaultRule(const DefaultRule&);
  DefaultRule &operator=(const DefaultRule&);
public:

  // Construct node
  DefaultRule(const FXString& nam,const FXString& sty,FXival par,FXival idx);

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar *textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~DefaultRule();
  };


// Simple highlight node
class SimpleRule : public Rule {
protected:
  FXRex         pattern;        // Pattern to match
protected:
  SimpleRule(){ }
private:
  SimpleRule(const SimpleRule&);
  SimpleRule &operator=(const SimpleRule&);
public:

  // Construct node
  SimpleRule(const FXString& nam,const FXString& sty,const FXString& rex,FXival par,FXival idx);

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar *textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~SimpleRule();
  };


// Bracketed highlight node
class BracketRule : public Rule {
protected:
  FXRex         open;           // Beginning pattern
  FXRex         close;          // Ending pattern
protected:
  BracketRule(){ }
private:
  BracketRule(const BracketRule&);
  BracketRule &operator=(const BracketRule&);
public:

  // Construct node
  BracketRule(const FXString& nam,const FXString& sty,const FXString& brex,const FXString& erex,FXival par,FXival idx);

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar *textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~BracketRule();
  };


// Bracketed highlight node with termination
class SafeBracketRule : public BracketRule {
protected:
  FXRex         stop;           // Termination pattern
protected:
  SafeBracketRule(){ }
private:
  SafeBracketRule(const SafeBracketRule&);
  SafeBracketRule &operator=(const SafeBracketRule&);
public:

  // Construct node
  SafeBracketRule(const FXString& nam,const FXString& sty,const FXString& brex,const FXString& erex,const FXString& srex,FXival par,FXival idx);

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar *textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~SafeBracketRule();
  };


// Span pattern rule
class SpanRule : public Rule {
protected:
  FXRex         pattern;        // Pattern to match
protected:
  SpanRule(){ }
private:
  SpanRule(const SpanRule&);
  SpanRule &operator=(const SpanRule&);
public:

  // Construct node
  SpanRule(const FXString& nam,const FXString& sty,const FXString& rex,FXival par,FXival idx);

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar *textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~SpanRule();
  };


/*
// Capturing pattern rule
class CapturingRule : public Rule {
protected:
  FXRex         pattern;        // Pattern to match
protected:
  CapturingRule(){ }
private:
  CapturingRule(const CapturingRule&);
  CapturingRule &operator=(const CapturingRule&);
public:

  // Construct node
  CapturingRule(const FXString& nam,const FXString& sty,const FXString& rex,FXival par,FXival idx);

  // Stylize text
  virtual FXint stylize(const FXchar* text,FXchar *textstyle,FXint pos,FXint len) const;

  // Stylize body, i.e. after begin pattern has been seen
  virtual FXint stylizeBody(const FXchar* text,FXchar* textstyle,FXint pos,FXint len) const;

  // Destructor
  virtual ~CapturingRule();
  };
*/

// Syntax for a language
class Syntax : public FXObject {
protected:
  RuleList      rules;          // Highlight rules
  FXString      language;       // Language name
  FXString      group;          // Group name for syntax coloring
  FXString      patterns;       // Wildcard patters to recognize language
  FXString      contents;       // Contents to recognize language
  FXString      delimiters;     // Word delimiters in this language
  FXint         contextLines;   // Context lines needed for restyle
  FXint         contextChars;   // Context characters needed for restyle
  FXint         autoindent;     // Auto indent for this language
  FXint         wrapwidth;      // Wrap text at this width
  FXint         tabwidth;       // Tab is this many columns
  FXint         wrapmode;       // Wrap lines on or off
  FXint         tabmode;        // Tab key inserts spaces
  FXint         strip;          // Strip spaces
protected:
  Syntax(){}
private:
  Syntax(const Syntax&);
  Syntax &operator=(const Syntax&);
public:

  // New language
  Syntax(const FXString& lang,const FXString& grp);

  // Get number of child rules
  FXival getNumRules() const { return rules.no(); }

  // Get rule
  Rule* getRule(FXival rule) const { return rules[rule]; }

  // Return true if p is ancestor of c
  FXbool isAncestor(FXival p,FXival c) const;

  // Return common ancestor of a and b
  FXival commonAncestor(FXival a,FXival b) const;

  // Language name
  void setName(const FXString& lang){ language=lang; }
  const FXString& getName() const { return language; }

  // Style coloring group
  void setGroup(const FXString& grp){ group=grp; }
  const FXString& getGroup() const { return group; }

  // Wildcard patterns
  void setPatterns(const FXString& wild){ patterns=wild; }
  const FXString& getPatterns() const { return patterns; }

  // Regular expression to match contents
  void setContents(const FXString& cont){ contents=cont; }
  const FXString& getContents() const { return contents; }

  // Delimiters
  void setDelimiters(const FXString& delims){ delimiters=delims; }
  const FXString& getDelimiters() const { return delimiters; }

  // Context lines
  void setContextLines(FXint num){ contextLines=num; }
  FXint getContextLines() const { return contextLines; }

  // Context characters
  void setContextChars(FXint num){ contextChars=num; }
  FXint getContextChars() const { return contextChars; }

  // Access auto-indent
  void setAutoIndent(FXint a){ autoindent=a; }
  FXint getAutoIndent() const { return autoindent; }

  // Access wrap width
  void setWrapWidth(FXint w){ wrapwidth=w; }
  FXint getWrapWidth() const { return wrapwidth; }

  // Access tab width
  void setTabWidth(FXint w){ tabwidth=w; }
  FXint getTabWidth() const { return tabwidth; }

  // Access line wrap mode
  void setWrapMode(FXint m){ wrapmode=m; }
  FXint getWrapMode() const { return wrapmode; }

  // Access tab expand mode
  void setTabMode(FXint m){ tabmode=m; }
  FXint getTabMode() const { return tabmode; }

  // Access strip trailing spaces
  void setStripSpaces(FXint s){ strip=s; }
  FXint getStripSpaces() const { return strip; }

  // Find rule index, given name
  FXint getNamedRule(const FXString& name) const;

  // Match filename against wildcards
  FXbool matchFilename(const FXString& name) const;

  // Match contents against regular expression
  FXbool matchContents(const FXString& text) const;

  // Append default rule
  FXival appendDefault(const FXString& name,const FXString& style,FXival parent=0);

  // Append simple rule
  FXival appendSimple(const FXString& name,const FXString& style,const FXString& rex,FXival parent=0);

  // Append span rule
  FXival appendSpan(const FXString& name,const FXString& style,const FXString& rex,FXival parent=0);

  // Append bracket rule
  FXival appendBracket(const FXString& name,const FXString& style,const FXString& brex,const FXString& erex,FXival parent=0);

  // Append safe bracket rule
  FXival appendSafeBracket(const FXString& name,const FXString& style,const FXString& brex,const FXString& erex,const FXString& srex,FXival parent=0);

  // Wipes the rules
  virtual ~Syntax();
  };


#endif