// Created on: 1992-06-22
// Created by: Gilles DEBARBOUILLE
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Units_Lexicon_HeaderFile
#define _Units_Lexicon_HeaderFile

#include "Standard.hxx"
#include "Standard_Type.hxx"

#include "Standard_Time.hxx"
#include "Units_Token.hxx"
#include "NCollection_Sequence.hxx"
#include "NCollection_HSequence.hxx"
#include "Standard_Transient.hxx"
#include "Standard_CString.hxx"
#include "Standard_Boolean.hxx"
#include "Standard_Real.hxx"

//! This class defines a lexicon useful to analyse and
//! recognize the different key words included in a
//! sentence. The lexicon is stored in a sequence of
//! tokens.
class Units_Lexicon : public Standard_Transient
{

public:
  //! Creates an empty instance of Lexicon.
  Standard_EXPORT Units_Lexicon();

  //! Reads the file <afilename> to create a sequence of tokens
  //! stored in <thesequenceoftokens>.
  Standard_EXPORT void Creates();

  //! Returns the first item of the sequence of tokens.
  occ::handle<NCollection_HSequence<occ::handle<Units_Token>>> Sequence() const;

  //! Adds to the lexicon a new token with <aword>, <amean>,
  //! <avalue> as arguments. If there is already a token
  //! with the field <theword> equal to <aword>, the
  //! existing token is updated.
  Standard_EXPORT void AddToken(const char* const aword,
                                const char* const amean,
                                const double      avalue);

  //! Useful for debugging.
  virtual void Dump() const;

  DEFINE_STANDARD_RTTIEXT(Units_Lexicon, Standard_Transient)

private:
  occ::handle<NCollection_HSequence<occ::handle<Units_Token>>> thesequenceoftokens;
};

#include "Units_Lexicon.lxx"

#endif // _Units_Lexicon_HeaderFile