Logo Search packages:      
Sourcecode: poco version File versions  Download package

DateTimeParser.h
//
// DateTimeParser.h
//
// $Id: //poco/1.3/Foundation/include/Poco/DateTimeParser.h#3 $
//
// Library: Foundation
// Package: DateTime
// Module:  DateTimeParser
//
// Definition of the DateTimeParser class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef Foundation_DateTimeParser_INCLUDED
#define Foundation_DateTimeParser_INCLUDED


#include "Poco/Foundation.h"
#include "Poco/DateTime.h"


namespace Poco {


00050 class Foundation_API DateTimeParser
      /// This class provides a method for parsing dates and times
      /// from strings. All parsing methods do their best to
      /// parse a meaningful result, even from malformed input
      /// strings.
      ///
      /// The returned DateTime will always contain a time in the same
      /// timezone as the time in the string. Call DateTime::makeUTC()
      /// with the timeZoneDifferential returned by parse() to convert
      /// the DateTime to UTC.
      ///
      /// Note: When parsing a time in 12-hour (AM/PM) format, the hour
      /// (%h) must be parsed before the AM/PM designator (%a, %A),
      /// otherwise the AM/PM designator will be ignored.
      ///
      /// See the DateTimeFormatter class for a list of supported format specifiers.
      /// In addition to the format specifiers supported by DateTimeFormatter, an
      /// additional specifier is supported: %r will parse a year given by either
      /// two or four digits. Years 69-00 are interpreted in the 20th century
      /// (1969-2000), years 01-68 in the 21th century (2001-2068).
{
public:
      static void parse(const std::string& fmt, const std::string& str, DateTime& dateTime, int& timeZoneDifferential);
            /// Parses a date and time in the given format from the given string.
            /// Throws a SyntaxException if the string cannot be successfully parsed.
            /// Please see DateTimeFormatter::format() for a description of the format string.
            /// Class DateTimeFormat defines format strings for various standard date/time formats.

      static DateTime parse(const std::string& fmt, const std::string& str, int& timeZoneDifferential);
            /// Parses a date and time in the given format from the given string.
            /// Throws a SyntaxException if the string cannot be successfully parsed.
            /// Please see DateTimeFormatter::format() for a description of the format string.
            /// Class DateTimeFormat defines format strings for various standard date/time formats.
            
      static bool tryParse(const std::string& fmt, const std::string& str, DateTime& dateTime, int& timeZoneDifferential);
            /// Parses a date and time in the given format from the given string.
            /// Returns true if the string has been successfully parsed, false otherwise.
            /// Please see DateTimeFormatter::format() for a description of the format string.
            /// Class DateTimeFormat defines format strings for various standard date/time formats.
            
      static void parse(const std::string& str, DateTime& dateTime, int& timeZoneDifferential);
            /// Parses a date and time from the given dateTime string. Before parsing, the method
            /// examines the dateTime string for a known date/time format.
            /// Throws a SyntaxException if the string cannot be successfully parsed.
            /// Please see DateTimeFormatter::format() for a description of the format string.
            /// Class DateTimeFormat defines format strings for various standard date/time formats.

      static DateTime parse(const std::string& str, int& timeZoneDifferential);
            /// Parses a date and time from the given dateTime string. Before parsing, the method
            /// examines the dateTime string for a known date/time format.
            /// Please see DateTimeFormatter::format() for a description of the format string.
            /// Class DateTimeFormat defines format strings for various standard date/time formats.
            
      static bool tryParse(const std::string& str, DateTime& dateTime, int& timeZoneDifferential);
            /// Parses a date and time from the given dateTime string. Before parsing, the method
            /// examines the dateTime string for a known date/time format.
            /// Please see DateTimeFormatter::format() for a description of the format string.
            /// Class DateTimeFormat defines format strings for various standard date/time formats.

      static int parseMonth(std::string::const_iterator& it, const std::string::const_iterator& end);
            /// Tries to interpret the given range as a month name. The range must be at least
            /// three characters long. 
            /// Returns the month number (1 .. 12) if the month name is valid. Otherwise throws
            /// a SyntaxException.

      static int parseDayOfWeek(std::string::const_iterator& it, const std::string::const_iterator& end);
            /// Tries to interpret the given range as a weekday name. The range must be at least
            /// three characters long. 
            /// Returns the weekday number (0 .. 6, where 0 = Synday, 1 = Monday, etc.) if the 
            /// weekday name is valid. Otherwise throws a SyntaxException.
            
protected:
      static int parseTZD(std::string::const_iterator& it, const std::string::const_iterator& end);
      static int parseAMPM(std::string::const_iterator& it, const std::string::const_iterator& end, int hour);
};


} // namespace Poco


#endif // Foundation_DateTimeParser_INCLUDED

Generated by  Doxygen 1.6.0   Back to index