/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#if !defined(ODA_ODMVDXMLHOSTAPPSERVICES_H_INCLUDED_)
#define ODA_ODMVDXMLHOSTAPPSERVICES_H_INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include "mvdXMLBuildOptions.h"
#include "DbBaseHostAppServices.h"
#include "MvdXmlProcessor.h"

#include "TD_PackPush.h"

/** \details 
The class implements platform-specific operations for the functionality of work with model view definitions in XML format (mvdXML module).
*/
class MVDXML_EXPORT OdMvdXmlHostAppServices : public OdDbBaseHostAppServices
{
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdMvdXmlHostAppServices);
  //DOM-IGNORE-END

  /** \details
  Creates a platform-specific operation services object for the mvdXML module with default parameters.
  */
  OdMvdXmlHostAppServices();

  /** \details
  Deletes a platform-specific operation services object for the mvdXML module.
  */
  ~OdMvdXmlHostAppServices();

  /** \details
  Retrieves the <exref target="../tifc_api_cpp/OdMvdXml__OdMvdXmlProcessor.html">mvdXML processor</exref> object.
  \param type [in] A <exref target="../tifc_api_cpp/OdMvdXml__ProccesorType.html">ProccesorType</exref> of the requested mvdXML processor.
  \returns A smart pointer to the <exref target="../tifc_api_cpp/OdMvdXml__OdMvdXmlProcessor.html">OdMvdXmlProcessor</exref> object.
  */
  OdMvdXml::OdMvdXmlProcessorPtr getProcessor(OdMvdXml::ProccesorType type);

  /** \details
  Retrieves the mvdXML database class description.
  \returns A pointer to the <exref target="../tkernel_api_cpp/OdRxClass.html">OdRxClass</exref> data type that represents the database class.
  */
  virtual OdRxClass* databaseClass() const;

  /** \details
  Searches for a specified file.
  \param filename [in] A name of the file to find.
  \param pDb      [in] A pointer to the database context. If the parameter value is equal to NULL, the file search is not related to a database.
  \param hint     [in] A hint that indicates the type of file that is required.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> that contains the full path to the found file; if the file was not found, the method returns an empty string.
  \remarks
  This method is called by IFC SDK when it needs to get access to a file, such as a font file, a template file, etc.
  If the pointer to the database context is not equal to NULL, it is possible to call the <exref target="../td_api_cpp/OdDbDatabase__getFilename@const.html">getFilename()</exref> method of the database instance
  to determine the full path to the IFC file associated with the database.
  The typical search order is the following:

  # The file name itself.
  # The current directory.
  # The drawing directory (for SHX font, image, and xref files).
  # The Windows fonts directory (only for TTF fonts on Windows platforms).

  The hint parameter's value must be one of the following:

  <table>
  <tr><th>Name</th>                   <th>Value</th>  <th>Description</th>                    <th>Extension</th></tr>
  <tr><td>kDefault</td>           <td>0</td>      <td>Any file.</td>                      <td>any</td></tr>
  <tr><td>kFontFile</td>          <td>1</td>      <td>Can be either SHX or TTF file.</td> <td>SHX or TTF</td></tr>
  <tr><td>kCompiledShapeFile</td> <td>2</td>      <td>SHX file.</td>                      <td>SHX</td></tr>
  <tr><td>kTrueTypeFontFile</td>  <td>3</td>      <td>TTF file.</td>                      <td>TTF</td></tr>
  <tr><td>kEmbeddedImageFile</td> <td>4</td>      <td>Image file.</td>                    <td>ISM</td></tr>
  <tr><td>kXRefDrawing</td>       <td>5</td>      <td>External reference file.</td>       <td></td></tr>
  <tr><td>kPatternFile</td>       <td>6</td>      <td>Pattern file (PAT).</td>            <td>PAT</td></tr>
  <tr><td>kDRXApplication</td>    <td>7</td>      <td>DRX application file.</td>          <td>DRX</td></tr>
  <tr><td>kFontMapFile</td>       <td>8</td>      <td>FontMap file.</td>                  <td>FMP</td></tr>
  </table>
  */
  virtual OdString findFile(
    const OdString& filename,
    OdDbBaseDatabase* pDb = 0,
    FindFileHint hint = kDefault);

  /** \details
  Retrieves the current name of the client program based on ODA IFC SDK.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object containing the custom application name.
  \remarks
  The default implementation of this method returns oddgGetLibraryInfo()->getLibName().
  This method is typically used for populating information about the application.
  */
  virtual const OdString program();

  /** \details
  Retrieves the current name of the client product based on ODA IFC SDK.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object containing the current name of the client product.
  \remarks
  The default implementation of this method returns program().
  This method is typically used for populating information about the product.
  */
  virtual const OdString product();

  /** \details
  Retrieves the current name of the client company.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object containing the current name of the client company.
  \remarks
  The default implementation of this method returns oddgGetLibraryInfo()->getCompanyName().
  This method is typically used for populating information about the client's company.
  */
  virtual const OdString companyName();

  /** \details
  Retrieves the major and minor numbers of the client application's version represented as a string.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object that contains the application's major and minor version numbers.
  \remarks
  The default implementation of this method returns oddgGetLibraryInfo()->getLibVersion().
  */
  virtual const OdString releaseMajorMinorString();

  /** \details
  Retrieves the release version of the client application represented as a string.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object that contains the release version of the client application.
  \remarks
  The default implementation of this method returns oddgGetLibraryInfo()->getLibVersion().
  */
  virtual const OdString versionString();

  /** \details
  Formats an error message string corresponding to the specified error code(s).
  \param errorCode [in] An error code.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> with a formatted error message.
  */
  virtual OdString formatMessage(
    unsigned int errorCode, ...);

  /** \details
  Retrieves the current default font name.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> that contains the path to the font file to be used when a given font file can not be found by IFC SDK.
  \remarks
  The default implementation of the method returns an empty string.
  \sa
  <exref target="../td/FontHandling.html">Font Handling</exref>
  */
  virtual OdString getAlternateFontName() const;

  /** \details
  Retrieves the current font mapping file. This font mapping file is used by the
  <exref target="../tkernel_api_cpp/OdIfcHostAppServices__getPreferableFont@const_OdString&@OdFontType.html">getPreferableFont()</exref> method.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> that contains the name of the font mapping file.
  \remarks
  The default implementation of this method returns an empty string.
  \sa
  <exref target="../td/FontHandling.html">Font Handling</exref>
  */
  virtual OdString getFontMapFileName() const;

  /** \details
  Retrieves the current preferable font name for a specified font name and type.
  \param fontName [in] A font name.
  \param fontType [in] A font type.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object containing the preferable font name.
  \remarks
  The default implementation of this method returns an empty string.

  The fontType parameter value must be one of the following:

  <table>
  <tr><th>Name</th>               <th>Value</th>  <th>Description</th></tr>
  <tr><td>kFontTypeUnknown</td>   <td>0</td>      <td>Unknown.</td></tr>
  <tr><td>kFontTypeShx</td>       <td>1</td>      <td>SHX font.</td></tr>
  <tr><td>kFontTypeTrueType</td>  <td>2</td>      <td>TrueType font.</td></tr>
  <tr><td>kFontTypeShape</td>     <td>3</td>      <td>Shape file.</td></tr>
  <tr><td>kFontTypeBig</td>       <td>4</td>      <td>BigFont file.</td></tr>
  </table>
  \sa
  <exref target="../td/FontHandling.html">Font Handling</exref>
  */
  virtual OdString getPreferableFont(
    const OdString& fontName,
    OdFontType fontType);

  /** \details
  Retrieves the current substitute font name. The substitute font is used in cases when a specified font is not found.
  \param fontName [in] A font name.
  \param fontType [in] A font type.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object that contains the substitute font name.
  \remarks
  The default implementation of this method returns an empty string.
  The fontType parameter value must be one of the following:

  <table>
  <tr><th>Name</th>               <th>Value</th>  <th>Description</th></tr>
  <tr><td>kFontTypeUnknown</td>   <td>0</td>      <td>Unknown.</th></tr>
  <tr><td>kFontTypeShx</td>       <td>1</td>      <td>SHX font.</th></tr>
  <tr><td>kFontTypeTrueType</td>  <td>2</td>      <td>TrueType font.</th></tr>
  <tr><td>kFontTypeShape</td>     <td>3</td>      <td>Shape file.</th></tr>
  <tr><td>kFontTypeBig</td>       <td>4</td>      <td>BigFont file.</th></tr>
  </table>
  \sa
  <exref target="../td/FontHandling.html">Font Handling</exref>
  */
  virtual OdString getSubstituteFont(
    const OdString& fontName,
    OdFontType fontType);

  /** \details
  Retrieves the typeface name of the TTF font that has the specified character.
  \param pFont        [in] A TTF font object.
  \param unicodeChar  [in] A symbol to find in the substitute font name.
  \param pDb          [in] A raw pointer to the database context.
  \returns A <exref target="../tkernel_api_cpp/OdString.html">string</exref> object that contains the substitute font name.
  \remarks
  The default method implementation uses the Windows API for getting the font.
  \sa
  <exref target="../td/FontHandling.html">Font Handling</exref>
  */
  virtual OdString getSubstituteFontByChar(
    const OdFont& pFont,
    OdChar unicodeChar, OdDbBaseDatabase* pDb);
};

#include "TD_PackPop.h"

#endif // !defined(ODA_ODMVDXMLHOSTAPPSERVICES_H_INCLUDED_)