Text.h

Go to the documentation of this file.

// Copyright 2002-2013 CEA LIST
// SPDX-FileCopyrightText: 2022 CEA LIST <gael.de-chalendar@cea.fr>
//
// SPDX-License-Identifier: MIT
 
// NAUTITIA
//
// jys 24-JUL-2002
//
// Text is the class which reads original text and does its
// 1st transformation into characters classes string.
 
#ifndef LIMA_LINGUISTICPROCESSING_FLATTOKENIZER_TEXT_H
#define LIMA_LINGUISTICPROCESSING_FLATTOKENIZER_TEXT_H
 
 
#include "FlatTokenizerExport.h"
#include "common/Data/LimaString.h"
#include "common/misc/Exceptions.h"
#include "linguisticProcessing/core/LinguisticAnalysisStructure/TStatus.h"
#include "linguisticProcessing/core/LinguisticAnalysisStructure/LinguisticGraph.h"
#include <wchar.h>
 
#include "CharChart.h"
 
 
namespace Lima
{
namespace LinguisticProcessing
{
namespace FlatTokenizer
{
 
class TextPrivate;
class LIMA_FLATTOKENIZER_EXPORT Text
{
friend class TextPrivate;
 
public:
  Text(MediaId lang, std::shared_ptr<CharChart> charChart);
  virtual ~Text();
  Text(const Text&) = delete;
  Text& operator=(const Text&) = delete;
 
  void setText(const Lima::LimaString& text);
 
  // Clear the entirely class and structure to accept new text
  void clear();
 
  // set graph in which insert token
  void setGraph(LinguisticGraphVertex position,LinguisticGraph* graph);
  void finalizeAndUnsetGraph();
 
  // gives the current character class
  const CharClass* currentClass() const;
 
  // gives the current character
  Lima::LimaChar currentChar() const;
 
  //
  // returns the character class with signed offset i
  Lima::LimaChar operator[] (int i) const;
 
  // increments text pointer
  Lima::LimaChar advance();
 
  // flushes current token
  void flush();
 
  // takes a token and add it to the result graph
  Lima::LimaString token();
 
  // performs a trace
  void trace();
 
  // sets token status
  void setAlphaCapital(const LinguisticAnalysisStructure::AlphaCapitalType alphaCapital);
  void setAlphaRoman(const LinguisticAnalysisStructure::AlphaRomanType alphaRoman);
  void setAlphaHyphen(const unsigned char isAlphaHyphen);
  void setAlphaPossessive(const unsigned char isAlphaPossessive);
  void setAlphaConcatAbbrev(const unsigned char isConcatAbbreviation);
  void setTwitter(const unsigned char isTwitter);
  void setNumeric(const LinguisticAnalysisStructure::NumericType numeric);
  void setStatus(const LinguisticAnalysisStructure::StatusType status);
  void setDefaultKey(const Lima::LimaString& defaultKey);
 
  int position() const;
  int size() const;
 
  void setStatus(const LinguisticAnalysisStructure::TStatus& status);
 
 void computeDefaultStatus();
 
private:
  TextPrivate* m_d;
};
 
} //namespace FlatTokenizer
} // namespace LinguisticProcessing
} // namespace Lima
 
#endif