XMLMsgLoader.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:10k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: XMLMsgLoader.hpp,v $
  58.  * Revision 1.6  2003/05/15 19:07:46  knoaman
  59.  * Partial implementation of the configurable memory manager.
  60.  *
  61.  * Revision 1.5  2003/03/07 18:11:55  tng
  62.  * Return a reference instead of void for operator=
  63.  *
  64.  * Revision 1.4  2003/02/17 19:54:47  peiyongz
  65.  * Allow set user specified error message file location in PlatformUtils::Initialize().
  66.  *
  67.  * Revision 1.3  2002/11/04 22:24:21  peiyongz
  68.  * Locale setting for message loader
  69.  *
  70.  * Revision 1.2  2002/11/04 15:22:05  tng
  71.  * C++ Namespace Support.
  72.  *
  73.  * Revision 1.1.1.1  2002/02/01 22:22:15  peiyongz
  74.  * sane_include
  75.  *
  76.  * Revision 1.5  2000/03/28 19:43:20  roddey
  77.  * Fixes for signed/unsigned warnings. New work for two way transcoding
  78.  * stuff.
  79.  *
  80.  * Revision 1.4  2000/03/02 19:54:49  roddey
  81.  * This checkin includes many changes done while waiting for the
  82.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  83.  * available elsewhere.
  84.  *
  85.  * Revision 1.3  2000/02/24 20:05:26  abagchi
  86.  * Swat for removing Log from API docs
  87.  *
  88.  * Revision 1.2  2000/02/06 07:48:05  rahulj
  89.  * Year 2K copyright swat.
  90.  *
  91.  * Revision 1.1.1.1  1999/11/09 01:05:47  twl
  92.  * Initial checkin
  93.  *
  94.  * Revision 1.2  1999/11/08 20:45:20  rahul
  95.  * Swat for adding in Product name and CVS comment log variable.
  96.  *
  97.  */
  98. #if !defined(XMLMSGLOADER_HPP)
  99. #define XMLMSGLOADER_HPP
  100. #include <xercesc/util/XMemory.hpp>
  101. XERCES_CPP_NAMESPACE_BEGIN
  102. //
  103. //  This header defines an abstract message loading API. This is the API via
  104. //  which the parser system loads translatable text, and there can be multiple
  105. //  actual implementations of this mechanism. The API is very simple because
  106. //  there can be many kinds of underlying systems on which implementations are
  107. //  based and we don't want to get into portability trouble by being overly
  108. //  smart.
  109. //
  110. //  Each instance of the message loader loads a file of messages, which are
  111. //  accessed by key and which are associated with a particular language. The
  112. //  actual source information may be in many forms, but by the time it is
  113. //  extracted for use it will be in Unicode format. The language is always
  114. //  the default language for the local machine.
  115. //
  116. //  Msg loader derivatives are not required to be thread safe. The parser will
  117. //  never use a single instance in more than one thread.
  118. //
  119. class XMLUTIL_EXPORT XMLMsgLoader : public XMemory
  120. {
  121. public :
  122.     // -----------------------------------------------------------------------
  123.     //  Class specific types
  124.     //
  125.     //  XMLMsgId
  126.     //      A simple typedef to give us flexibility about the representation
  127.     //      of a message id.
  128.     // -----------------------------------------------------------------------
  129.     typedef unsigned int    XMLMsgId;
  130.     // -----------------------------------------------------------------------
  131.     //  Public Constructors and Destructor
  132.     // -----------------------------------------------------------------------
  133.     virtual ~XMLMsgLoader();
  134.     // -----------------------------------------------------------------------
  135.     //  The virtual message loader API
  136.     // -----------------------------------------------------------------------
  137.     virtual bool loadMsg
  138.     (
  139.         const   XMLMsgId        msgToLoad
  140.         ,       XMLCh* const    toFill
  141.         , const unsigned int    maxChars
  142.     ) = 0;
  143.     virtual bool loadMsg
  144.     (
  145.         const   XMLMsgId        msgToLoad
  146.         ,       XMLCh* const    toFill
  147.         , const unsigned int    maxChars
  148.         , const XMLCh* const    repText1
  149.         , const XMLCh* const    repText2 = 0
  150.         , const XMLCh* const    repText3 = 0
  151.         , const XMLCh* const    repText4 = 0
  152.     ) = 0;
  153.     virtual bool loadMsg
  154.     (
  155.         const   XMLMsgId        msgToLoad
  156.         ,       XMLCh* const    toFill
  157.         , const unsigned int    maxChars
  158.         , const char* const     repText1
  159.         , const char* const     repText2 = 0
  160.         , const char* const     repText3 = 0
  161.         , const char* const     repText4 = 0
  162.     ) = 0;
  163.     /** @name Locale Handling  */
  164.     //@{
  165.     /**
  166.       * This function enables set the locale information which
  167.       * all concrete message loaders shall refer to during instantiation.
  168.       *
  169.       * Note: for detailed discussion, refer to PlatformUtils::initalize()
  170.       */
  171.     static void           setLocale(const char* const localeToAdopt);
  172.     /**
  173.       * For the derived to retrieve locale info during construction
  174.       */
  175.     static const char*    getLocale();
  176.     //@}
  177.     /** @name NLSHome Handling  */
  178.     //@{
  179.     /**
  180.       * This function enables set the NLSHome information which
  181.       * all concrete message loaders shall refer to during instantiation.
  182.       *
  183.       * Note: for detailed discussion, refer to PlatformUtils::initalize()
  184.       */
  185.     static void           setNLSHome(const char* const nlsHomeToAdopt);
  186.     /**
  187.       * For the derived to retrieve NLSHome info during construction
  188.       */
  189.     static const char*    getNLSHome();
  190.     //@}
  191.     // -----------------------------------------------------------------------
  192.     //  Deprecated: Getter methods
  193.     // -----------------------------------------------------------------------
  194.     virtual const XMLCh* getLanguageName() const;
  195. protected :
  196.     // -----------------------------------------------------------------------
  197.     //  Hidden Constructors
  198.     // -----------------------------------------------------------------------
  199.     XMLMsgLoader();
  200.     // -----------------------------------------------------------------------
  201.     //  Deprecated: Protected helper methods
  202.     // -----------------------------------------------------------------------
  203.     void setLanguageName(XMLCh* const nameToAdopt);
  204. private :
  205.     // -----------------------------------------------------------------------
  206.     //  Unimplemented constructors and operators
  207.     // -----------------------------------------------------------------------
  208.     XMLMsgLoader(const XMLMsgLoader&);
  209.     XMLMsgLoader& operator=(const XMLMsgLoader&);
  210.     // -----------------------------------------------------------------------
  211.     //  Private data members
  212.     //
  213.     //  fLocale
  214.     //      Locale info set through PlatformUtils::init().
  215.     //      The derived class may refer to this for locale information.
  216.     //
  217.     //  fPath
  218.     //      NLSHome info set through PlatformUtils::init().
  219.     //      The derived class may refer to this for NLSHome information.
  220.     //
  221.     // -----------------------------------------------------------------------
  222.     static char*    fLocale;
  223.     static char*    fPath;
  224.     static XMLCh    fLanguage[];
  225. };
  226. // ---------------------------------------------------------------------------
  227. //  XMLMsgLoader: Public Constructors and Destructor
  228. // ---------------------------------------------------------------------------
  229. inline XMLMsgLoader::~XMLMsgLoader()
  230. {
  231. }
  232. // ---------------------------------------------------------------------------
  233. //  XMLMsgLoader: Hidden Constructors
  234. // ---------------------------------------------------------------------------
  235. inline XMLMsgLoader::XMLMsgLoader()
  236. {
  237. }
  238. XERCES_CPP_NAMESPACE_END
  239. #endif