src/FlightCrew/Validators/Xml/UsesUnicode.h

   1 /************************************************************************\r
   2 **\r
   3 **  Copyright (C) 2010  Strahinja Markovic\r
   4 **\r
   5 **  This file is part of FlightCrew.\r
   6 **\r
   7 **  FlightCrew is free software: you can redistribute it and/or modify\r
   8 **  it under the terms of the GNU Lesser General Public License as published\r
   9 **  by the Free Software Foundation, either version 3 of the License, or\r
  10 **  (at your option) any later version.\r
  11 **\r
  12 **  FlightCrew is distributed in the hope that it will be useful,\r
  13 **  but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  14 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  15 **  GNU Lesser General Public License for more details.\r
  16 **\r
  17 **  You should have received a copy of the GNU Lesser General Public License\r
  18 **  along with FlightCrew.  If not, see <http://www.gnu.org/licenses/>.\r
  19 **\r
  20 *************************************************************************/\r
  21 \r
  22 #pragma once\r
  23 #ifndef USESUNICODE_H\r
  24 #define USESUNICODE_H\r
  25 \r
  26 #include "../IValidator.h"\r
  27 \r
  28 namespace FlightCrew\r
  29 {\r
  30 \r
  31 class UsesUnicode : public IValidator\r
  32 {\r
  33 \r
  34 public:\r
  35 \r
  36     std::vector< Result > ValidateFile( const fs::path &filepath );\r
  37 \r
  38 private:\r
  39 \r
  40     /**\r
  41      * Checks if the file contains a valid utf8 bytestream.\r
  42      *\r
  43      * @param filepath The path to the file to check.\r
  44      * @return \c true when valid utf8\r
  45      */\r
  46     bool FileIsValidUtf8( const fs::path &filepath );\r
  47 \r
  48     /**\r
  49      * Gets the first num_chars characters from the file.\r
  50      *\r
  51      * @param filepath The path to the file to check.\r
  52      * @return The starting characters.\r
  53      */\r
  54     std::string GetFirstNumCharsFromFile( const fs::path &filepath,\r
  55                                           unsigned int num_chars );\r
  56 \r
  57     /**\r
  58      * Checks if the line contains an utf8 encoding declaration.\r
  59      *\r
  60      * @param line A line of text, preferably with an xml declaration.\r
  61      * @return \c true when line specifies utf8.\r
  62      */\r
  63     bool FileDeclaresUtf8( const std::string &line );\r
  64 \r
  65     /**\r
  66      * Checks if the line contains an utf16 encoding declaration.\r
  67      *\r
  68      * @param line A line of text, preferably with an xml declaration.\r
  69      * @return \c true when line specifies utf16.\r
  70      */\r
  71     bool FileDeclaresUtf16( const std::string &line );\r
  72 \r
  73     /**\r
  74      * Checks if the line contains an xml declaration.\r
  75      *\r
  76      * @param line A line of text.\r
  77      * @return \c true when line contains an xml declaration.\r
  78      */\r
  79     bool HasXmlDeclaration( const std::string &line );\r
  80 \r
  81     /**\r
  82      * Returns the specified encoding in a line containing an xml declaration.\r
  83      *\r
  84      * @param line A line of text, preferably with an xml declaration.\r
  85      * @return The encoding used.\r
  86      */\r
  87     std::string GetDeclaredEncoding( const std::string &line );\r
  88 \r
  89 };\r
  90 \r
  91 } // namespace FlightCrew\r
  92 \r
  93 #endif // USESUNICODE_H\r