/*  GNU Ocrad - Optical Character Recognition program
    Copyright (C) 2003-2019 Antonio Diaz Diaz.

    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 2 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/>.
*/

class Page_image;
class Rational;

class Textline : public Track
  {
  int big_initials_;
  mutable std::vector< Character * > cpv;

  void check_lower_ambiguous();

public:
  Textline() : big_initials_( 0 ) {}
  Textline( const Textline & tl );
  Textline & operator=( const Textline & tl );
  ~Textline();
  void set_track();
  void verify_big_initials();

  int big_initials() const { return big_initials_; }
  Character & character( const int i ) const;
  Character * character_at( const int col ) const;
  int characters() const { return cpv.size(); }
  Rectangle charbox( const Character & c ) const;
  int width() const
    { return cpv.empty() ? 0 : cpv.back()->right() - cpv.front()->left(); }

  bool is_key_character( const int i ) const;	// isalnum of normal size

  void delete_character( const int i );
  int  shift_characterp( Character * const p, const bool big = false );
  bool insert_space( const int i, const bool tab = false );
  void insert_spaces();
  void join( Textline & tl );

  int mean_height() const;
  Rational mean_width() const;
  Rational mean_gap_width( const int first = 0, int last = -1 ) const;
  int mean_hcenter() const;
  int mean_vcenter() const;

  void print( const Control & control ) const;
  void dprint( const Control & control, const bool graph,
               const bool recursive ) const;
  void xprint( const Control & control ) const;
  void cmark( Page_image & page_image ) const;

  void recognize1( const Charset & charset ) const;
  void recognize2( const Charset & charset );
  void apply_filter( const Filter::Type filter );
  void apply_user_filter( const User_filter & user_filter );
  void join_broken_unrecognized_characters();
  void remove_leadind_trailing_duplicate_spaces();
  };