#ifndef _COLORER_BASEEDITOR_H_
#define _COLORER_BASEEDITOR_H_

#include<colorer/ParserFactory.h>
#include<colorer/handlers/FileErrorHandler.h>
#include<colorer/handlers/LineRegionsSupport.h>
#include<colorer/handlers/LineRegionsCompactSupport.h>

#include<colorer/editor/PairMatch.h>

/** Base Editor functionality.
    This class implements basic functionality,
    which could be useful in application's editing system.
    This includes automatic top-level caching of hilighting
    state, outline structure creation, pair constructions search.
    This class has event-oriented structure. Each editor event
    is passed into this object and gets internal processing.
    @ingroup colorer_editor
*/
class BaseEditor : public RegionHandler{
public:
  /** Initial constructor.
      Creates uninitialized base editor functionality support.
      @param pf ParserFactory, used as source of all created
             parsers (HRC, HRD, Text parser). Can't be null.
      @param lineSource Object, that provides parser with
             text data in line-separated form. Can't be null.
  */
  BaseEditor(ParserFactory *pf, LineSource *lineSource);
  ~BaseEditor();

  /** This method informs handler about internal form of
      requeried LineRegion lists, which returned after parse
      process. Compact regions are guaranteed not to overlap
      with each other (this is achieved with more internal processing
      and more extensive cpu use); non-compact regions are placed directly
      as they created by TextParser and can be overlapped.
      @note By default, if method is not called, regions are not compacted.
      @param compact Creates LineRegionsSupport (false) or LineRegionsCompactSupport (true)
             object to store lists of RegionDefine's
  */
  void setRegionCompact(bool compact);

  /** Installs specified RegionMapper, which
      maps HRC Regions into color data.
      @param rm RegionMapper object to map region values into colors.
  */
  void setRegionMapper(RegionMapper *rm);

  /** Installs specified RegionMapper, which
      is created with ParserFactory methods and maintained internally by this handler.
      If no one of two overloads of setRegionMapper is called,
      all work is started without mapping of extended region information.
      @param hrdClass Class of RegionMapper instance
      @param hrdName  Name of RegionMapper instance
  */
  void setRegionMapper(const String *hrdClass, const String *hrdName);

  /** Specifies number of lines, for which parser
      would be able to run continual processing without
      highlight invalidation.
  */
  void setBackParse(int backParse);

  /** Initial HRC type, used for parse processing.
      If changed during processing, all text information
      is invalidated.
  */
  void setFileType(FileType *ftype);
  /** Initial HRC type, used for parse processing.
      If changed during processing, all text information is invalidated.
  */
  void setFileType(const String &fileType);
  /** Tries to choose appropriate file type from HRC database
      using passed fileName and first line of text (if available through lineSource)
  */
  void chooseFileType(const String *fileName);

  /** Returns currently used HRC file type */
  FileType *getFileType();

  /** Adds specified RegionHandler object
      into parse process.
  */
  void addRegionHandler(RegionHandler *rh);

  /** Removes previously added RegionHandler object.
  */
  void removeRegionHandler(RegionHandler *rh);

  /** Searches and creates pair match object.
      Returned object could be lately used in pair search methods.
      This object is valid only until reparse of it's line
      occured. After that event information about line region's
      references in it becomes invalid and, if used, can produce
      faults.
      @param lineNo Line number, where to search paired region.
      @param pos Position in line, where paired region to be searched.
             Paired Region is found, if it includes specified position
             or ends directly at one char before line position.
  */
  PairMatch *getPairMatch(int lineNo, int pos);

  /** Searches and creates pair match object of first enwrapping block.
      Returned object could be used as with getPairMatch method.
      Enwrapped block is the first meeted start of block, if moving
      from specified position to the left and top.
      @param lineNo Line number, where to search paired region.
      @param pos Position in line, where paired region to be searched.
  */
  PairMatch *getEnwrappedPairMatch(int lineNo, int pos);

  /** Frees previously allocated PairMatch object.
      @param pm PairMatch object
  */
  void releasePairMatch(PairMatch *pm);

  /** Searches pair match in currently visible text.
      @param pm Unmatched pair match
  */
  void searchLocalPair(PairMatch *pm);

  /** Searches pair match in all available text, possibly,
      making additional processing.
      @param pm Unmatched pair match
  */
  void searchGlobalPair(PairMatch *pm);

  /** Return parsed and colored LineRegions of requested line.
      This method validates current cache state
      and, if needed, calls Colorer parser to validate modified block of text.
      Size of reparsed text is choosed according to information
      about visible text range and modification events.
      @todo If number of lines, to be reparsed is more, than backParse parameter,
      then method will return null, until validate() method is called.
  */
  LineRegion *getLineRegions(int lno);

  /** Validates current state of editor and runs parser, if needed.
      This method can be called periodically in background thread
      to make possible background parsing process.
      @param lno Line number, for which validation is requested.
             If this number is in current visible window range,
             the part of text is validated, which is requeried
             for visual painting.
             If this number is not in visible range, or equals to -1,
             all the text is validated.
  */
  void validate(int lno);

  /** Informs BaseEditor object about text modification event.
      All the text becomes invalid after the specified line.
      @param topLine Topmost modified line of text.
  */
  void modifyEvent(int topLine);

  /** Informs about single line modification event.
      Generally, this type of event can be processed much faster
      because of pre-checking line's changed structure and
      cancelling further parsing in case of unmodified text structure.
      @param line Modified line of text.
      @todo Not used yet! This must include special 'try' parse method.
  */
  void modifyLineEvent(int line);

  /** Informs about changes in visible range of text lines.
      This information is used to make assumptions about
      text structure and to make faster parsing.
      @param wStart Topmost visible line of text.
      @param wSize  Number of currently visible text lines.
                    This number must includes all partially visible lines.
  */
  void visibleTextEvent(int wStart, int wSize);

  /** Informs about total lines count change.
      This must include initial lines number setting.
  */
  void lineCountEvent(int newLineCount);

  /** Basic HRC region - default text (background color) */
  const Region *def_Text;
  /** Basic HRC region - syntax checkable region */
  const Region *def_Syntax;
  /** Basic HRC region - special region */
  const Region *def_Special;
  /** Basic HRC region - Paired region start */
  const Region *def_PairStart;
  /** Basic HRC region - Paired region end */
  const Region *def_PairEnd;

  /** Basic HRC region mapping */
  const RegionDefine *rd_def_Text, *rd_def_HorzCross, *rd_def_VertCross;

  void startParsing(int lno);
  void endParsing(int lno);
  void clearLine(int lno, String *line);
  void addRegion(int lno, String *line, int sx, int ex, const Region *region);
  void enterScheme(int lno, String *line, int sx, int ex, const Region *region, const Scheme *scheme);
  void leaveScheme(int lno, String *line, int sx, int ex, const Region *region, const Scheme *scheme);

private:
  HRCParser *hrcParser;
  TextParser *textParser;
  ParserFactory *parserFactory;
  LineSource *lineSource;
  RegionMapper *regionMapper;
  LineRegionsSupport *lrSupport;

  FileType *currentFileType;
  Vector<RegionHandler*> regionHandlers;

  int backParse;
  // window area
  int wStart, wSize;
  // line count
  int lineCount;
  // size of line regions
  int lrSize;
  // position of last validLine
  int invalidLine;
  // no lines structure changes, just single line change
  int changedLine;

  bool internalRM;
  bool regionCompact;
  bool breakParse;
  bool validationProcess;

  inline int getLastVisibleLine();
  void remapLRS(bool recreate);
protected:
  ErrorHandler *feh;
};

#endif
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Colorer Library.
 *
 * The Initial Developer of the Original Code is
 * Cail Lomecb <cail@nm.ru>.
 * Portions created by the Initial Developer are Copyright (C) 1999-2003
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
