Return to LanguageParser.h CVS log | Up to [Pegasus] / pegasus / src / Pegasus / Common |
File: [Pegasus] / pegasus / src / Pegasus / Common / LanguageParser.h
(download)
Revision: 1.21, Fri Nov 10 18:14:58 2006 UTC (17 years, 7 months ago) by kumpf Branch: MAIN CVS Tags: TASK_PEP328_SOLARIS_NEVADA_PORT, TASK-PEP328_SOLARIS_NEVADA_PORT_v2-root, TASK-PEP328_SOLARIS_NEVADA_PORT_v2-branch, TASK-PEP328_SOLARIS_NEVADA_PORT-root, TASK-PEP328_SOLARIS_NEVADA_PORT-branch, TASK-PEP328_SOLARIS_IX86_CC_PORT-root, TASK-PEP328_SOLARIS_IX86_CC_PORT-branch-v2, TASK-PEP328_SOLARIS_IX86_CC_PORT-branch, TASK-PEP311_WSMan-root, TASK-PEP311_WSMan-branch, TASK-PEP305_VXWORKS-root, TASK-PEP305_VXWORKS-branch-pre-solaris-port, TASK-PEP305_VXWORKS-branch-post-solaris-port, TASK-PEP305_VXWORKS-branch-beta2, TASK-PEP305_VXWORKS-branch, TASK-PEP305_VXWORKS-2008-10-23, TASK-PEP291_IPV6-root, TASK-PEP291_IPV6-branch, TASK-PEP286_PRIVILEGE_SEPARATION-root, TASK-PEP286_PRIVILEGE_SEPARATION-branch, TASK-PEP274_dacim-root, TASK-PEP274_dacim-merged_out_to_branch, TASK-PEP274_dacim-merged_out_from_trunk, TASK-PEP274_dacim-merged_in_to_trunk, TASK-PEP274_dacim-merged_in_from_branch, TASK-PEP274_dacim-branch, TASK-Bug2102_RCMPIWindows-root, TASK-Bug2102_RCMPIWindows-merged_out_to_branch, TASK-Bug2102_RCMPIWindows-merged_out_from_trunk, TASK-Bug2102_RCMPIWindows-merged_in_to_trunk, TASK-Bug2102_RCMPIWindows-merged_in_from_branch, TASK-Bug2102_RCMPIWindows-branch, TASK-Bug2102Final-root, TASK-Bug2102Final-merged_out_to_branch, TASK-Bug2102Final-merged_out_from_trunk, TASK-Bug2102Final-merged_in_to_trunk, TASK-Bug2102Final-merged_in_from_branch, TASK-Bug2102Final-branch, TASK-BUG7240-root, TASK-BUG7240-branch, TASK-BUG7146_SqlRepositoryPrototype-root, TASK-BUG7146_SqlRepositoryPrototype-merged_out_to_branch, TASK-BUG7146_SqlRepositoryPrototype-merged_out_from_trunk, TASK-BUG7146_SqlRepositoryPrototype-merged_in_to_trunk, TASK-BUG7146_SqlRepositoryPrototype-merged_in_from_branch, TASK-BUG7146_SqlRepositoryPrototype-branch, RELEASE_2_8_2-RC1, RELEASE_2_8_2, RELEASE_2_8_1-RC1, RELEASE_2_8_1, RELEASE_2_8_0_BETA, RELEASE_2_8_0-RC2, RELEASE_2_8_0-RC1, RELEASE_2_8_0-FC, RELEASE_2_8_0, RELEASE_2_8-root, RELEASE_2_8-branch, RELEASE_2_7_3-RC1, RELEASE_2_7_3, RELEASE_2_7_2-RC1, RELEASE_2_7_2, RELEASE_2_7_1-RC1, RELEASE_2_7_1, RELEASE_2_7_0-RC1, RELEASE_2_7_0-BETA, RELEASE_2_7_0, RELEASE_2_7-root, RELEASE_2_7-branch, RELEASE_2_6_3-RC2, RELEASE_2_6_3-RC1, RELEASE_2_6_3, RELEASE_2_6_2-RC1, RELEASE_2_6_2, RELEASE_2_6_1-RC1, RELEASE_2_6_1, RELEASE_2_6_0-RC1, RELEASE_2_6_0-FC, RELEASE_2_6_0, RELEASE_2_6-root, RELEASE_2_6-branch-clean, RELEASE_2_6-branch, PEP286_PRIVILEGE_SEPARATION_ROOT, PEP286_PRIVILEGE_SEPARATION_CODE_FREEZE, PEP286_PRIVILEGE_SEPARATION_BRANCH, PEP286_PRIVILEGE_SEPARATION_1, Makefile Changes since 1.20: +0 -6 lines BUG#: 5840 TITLE: Common modules do not meet chksrc requirements DESCRIPTION: Remove tab characters and author names and shorten lines that are wider than 80 characters. |
//%2006//////////////////////////////////////////////////////////////////////// // // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; // IBM Corp.; EMC Corporation, The Open Group. // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; // EMC Corporation; VERITAS Software Corporation; The Open Group. // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; // EMC Corporation; Symantec Corporation; The Open Group. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to // deal in the Software without restriction, including without limitation the // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or // sell copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. // //============================================================================== // //%///////////////////////////////////////////////////////////////////////////// #ifndef Pegasus_LanguageParser_h #define Pegasus_LanguageParser_h #include <cstdlib> #include <cctype> #include <Pegasus/Common/Linkage.h> #include <Pegasus/Common/Config.h> #include <Pegasus/Common/String.h> #include <Pegasus/Common/Array.h> #include <Pegasus/Common/AcceptLanguageList.h> #include <Pegasus/Common/ContentLanguageList.h> PEGASUS_NAMESPACE_BEGIN /** This class parses and validates Accept-Language and Content-Language values from the respective HTTP headers, and provides utility functions to parse and manipulate language information */ class PEGASUS_COMMON_LINKAGE LanguageParser { public: /** Builds an AcceptLanguageList object from an HTTP Accept-Language header value. @param acceptLanguageHeader A String containing an HTTP Accept-Language header value from which to build the AcceptLanguageList object. @exception InvalidAcceptLanguageHeader if a syntax error is encountered. */ static AcceptLanguageList parseAcceptLanguageHeader( const String& acceptLanguageHeader); /** Builds a ContentLanguageList object from an HTTP Content-Language header value. @param contentLanguageHeader A String containing an HTTP Content-Language header value from which to build the ContentLanguageList object. @exception InvalidContentLanguageHeader if a syntax error is encountered. */ static ContentLanguageList parseContentLanguageHeader( const String& contentLanguageHeader); /** Validates the syntax of a language tag according to RFC 3066. Parses the language tag into language, country, and variant, if the language tag is formed using ISO codes (ISO 639 and ISO 3166). @param languageTagString The language tag string to parse and validate. @param language The returned language value parsed from the language tag, if applicable. @param country The returned country value parsed from the language tag, if applicable. @param variant The returned language variant value parsed from the language tag, if applicable. @exception Exception if the language tag is syntactically invalid. */ static void parseLanguageTag( const String& languageTagString, String& language, String& country, String& variant); /** Validates the syntax of an Accept-Language quality value. @param quality A Real32 quality value to validate. @exception Exception if the quality value is invalid. */ static void validateQualityValue(Real32 quality); /** Builds an HTTP Accept-Language header value from an AcceptLanguageList object. @param acceptLanguages The AcceptLanguageList object to be encoded in an HTTP Accept-Language header. */ static String buildAcceptLanguageHeader( const AcceptLanguageList& acceptLanguages); /** Builds an HTTP Content-Language header value from a ContentLanguageList object. @param contentLanguages The ContentLanguageList object to be encoded in an HTTP Content-Language header. */ static String buildContentLanguageHeader( const ContentLanguageList& contentLanguages); #ifdef PEGASUS_HAS_ICU /** Converts a locale ID to language tag syntax by replacing the '_' separators with '-' separators. @param localeId The locale ID string to convert to language tag syntax. The conversion is performed on the localeId object directly. @return The converted String with language tag syntax. */ static String& convertLocaleIdToLanguageTag(String& localeId); #endif /** Returns the default accept languages based on environment settings. ATTN: What is the behavior? This is only implemented if MESSAGES and ICU are used. */ static AcceptLanguageList getDefaultAcceptLanguages(); private: /** Parses the value portion of an HTTP Accept-Language or Content-Language header into individual language elements. Comments and whitespace are removed. @param headerElements An array of Strings into which the language elements are stored. @param languageHeaderValue A String containing the value portion of an HTTP Accept-Language or Content-Language header. @exception Exception if a syntax error is encountered. */ static void _parseLanguageHeader( const String& languageHeaderValue, Array<String>& languageElements); /** Parses an AcceptLanguage or ContentLanguage value from a header. If a valid AcceptLanguage value is determined to contain a quality value, then this quality is validated and returned. Otherwise -1 is returned. It is up to the caller to know in what context this call is being made, that is: it is the callers responsibility to know whether an AcceptLanguage or a ContentLanguage value is being parsed. @param acceptLanguageHeaderElement String to be parsed into a language tag and quality value. The String must not contain comments or whitespace. @param languageTag String into which the parsed language tag is stored. @param quality Real32 into which the parsed quality value is stored. @exception Exception if a syntax error is encountered. */ static void _parseAcceptLanguageElement( const String& acceptLanguageElement, String& languageTag, Real32& quality); /** Fills the first position in the array with the most general part of the language String, each subsequent postion is the array gets more and more detailed. For example: en-us-fooblah would be returned as ["en"]["us"]["fooblah"] @param subtags Array<String>& array filled in with the root and subtags @param languageTag String the language to parse @return String the root of the language tag @exception Exception if a syntax error is encountered. */ static void _parseLanguageSubtags( Array<String>& subtags, const String& languageTagString); /** Checks if a String represents a valid language tag primary subtag. A valid primary subtag contains 1 to 8 alphabetic characters. @param subtag The subtag String to validate. @return True if the String represents a valid language tag primary subtag; false otherwise. */ static Boolean _isValidPrimarySubtagSyntax(const String& subtag); /** Checks if a String represents a valid language tag subtag. A valid primary subtag contains 1 to 8 alphanumeric characters. @param subtag The subtag String to validate. @return True if the String represents a valid language tag subtag; false otherwise. */ static Boolean _isValidSubtagSyntax(const String& subtag); }; PEGASUS_NAMESPACE_END #endif
No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |