xcksfilereader_1.hpp

Go to the documentation of this file.

/*
 * libxcks
 * Copyright (C) 2022 Julien Couot
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef INC_XCKSFILEREADER_1_HPP_1B941C5D_4F8F_4379_9279_18E35D5DD8EB
#define INC_XCKSFILEREADER_1_HPP_1B941C5D_4F8F_4379_9279_18E35D5DD8EB
 
//---------------------------------------------------------------------------
#include <set>
#include <stack>
#include <vector>
#include <cstdint>
#include <ctime>
 
#if defined(_MSC_VER)
#include <BaseTsd.h>
#endif
 
#include "libxcks/handlers.hpp"
// #include "libxcks/types.hpp"  // included in "libxcks/handlers.hpp"
#include "libxcks/ckvalue.hpp"
#include "xmlparser.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
#if defined(_MSC_VER)
typedef SSIZE_T ssize_t;
#endif
 
class XCKS1FileHandler final : public XMLParserDefaultHandler
{
 protected:
  enum class XMLTags : int16_t
  {
    BAD_TAG = INT16_MIN,        
    SEQ_BEGIN = INT16_MIN / 2,  
    CHECKSUMSFILE = 0x001,      
    GENERATED = 0x100,          
    ALGORITHMS = 0x300,         
    ALGORITHM = 0x201,          
    LOCALFILES = 0x500,         
    PARENTDIRECTORY = 0x510,    
    DIRECTORY = 0x520,          
    FILE = 0x530,               
    INFORMATION = 0x531,        
    CHECKSUM = 0x532            
  };
 
  static const std::string parentDir;            // Parent directory.
 
  XCKSReaderHandler&  readerHandler;             
  const std::filesystem::path baseDirectory;     
  const std::vector<std::filesystem::path>  baseDirectoryDirs;  
  ssize_t             curBaseDirectoryDir;       
  // Position in the checksums' file.
  std::stack<XMLTags> readTags;                  
  XMLTags             tagInChecksumsFileTag;     
  // Algos for the checksums file.
  const StringSet     possibleSumsAlgosName;     
  ArrayChecksumAlgoId sumsAlgos;                 
  // Current directory
  ArrayString         currentRelativeDirectory;  
  std::stack<StringSet> namesInDirectories;      
  // Information on current file.
  std::string         fileName;                  
  XMLTags             tagInFileTag;              
  uintmax_t           fileLength;                
  time_t              lastFileModicationTime;    
  ArrayChecksumAlgoId algosToRead;               
  ArrayChecksumValue  readChecksumsValues;       
 
 public:
  XCKS1FileHandler() = delete;
 
  XCKS1FileHandler(const XCKS1FileHandler&) = delete;
 
  XCKS1FileHandler& operator=(const XCKS1FileHandler&) = delete;
 
  // Constructor.
  XCKS1FileHandler(XCKSReaderHandler& handler, const std::filesystem::path& baseDir);
 
  // Destructor.
  virtual ~XCKS1FileHandler();
 
 protected:
  // Gets a XML tag identifier from a string.
  XMLTags stringToXMLTags(const std::string& str);
 
  // Receives notification of the beginning of a "generated" element.
  inline void startGeneratedElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of an "algorithms" element.
  inline void startAlgorithmsElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of an "algorithm" element.
  inline void startAlgorithmElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of a "localFiles" element.
  inline void startLocalFilesElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of a "parentDirectory" element.
  inline void startParentDirectoryElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of a "directory" element.
  inline void startDirectoryElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of a "file" element.
  inline void startFileElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of a "information" element.
  inline void startInformationElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the beginning of a "checksum" element.
  inline void startChecksumElement(const XMLParserAttributes& atts) noexcept(false);
 
  // Receives notification of the end of a "file" element.
  inline void endFileElement() noexcept(false);
 
 public:
  // Receives notification of the beginning of an element.
  void startElement(const std::string& name, const XMLParserAttributes& atts) noexcept(false) override;
 
  // Receives notification of the end of an element.
  void endElement(const std::string& name) noexcept(false) override;
 
  // Receives notification of character data.
  void characters(const std::string& chars) noexcept(false) override;
 
  // Receive notification of a non-recoverable error.
  void fatalError(XML_Error errorCode, const std::string& errorMessage, int line, int column) noexcept override;
};
//---------------------------------------------------------------------------
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_XCKSFILEREADER_1_HPP_1B941C5D_4F8F_4379_9279_18E35D5DD8EB