POUtils.h

/*
 *  Copyright (C) 2012-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include <stdint.h>
#include <string>
#include <vector>

typedef enum
{
  ID_FOUND = 0, // We have an entry with a numeric (previously XML) identification number.
  MSGID_FOUND = 1, // We have a classic gettext entry with textual msgid. No numeric ID.
  MSGID_PLURAL_FOUND = 2 // We have a classic gettext entry with textual msgid in plural form.
} POIdType;

enum
{
  ISSOURCELANG=true
};

// Struct to hold current position and text of the string field in the main PO entry.
struct CStrEntry
{
  size_t Pos;
  std::string Str;
};

// Struct to collect all important data of the current processed entry.
struct CPOEntry
{
  int Type;
  uint32_t xID;
  size_t xIDPos;
  std::string Content;
  CStrEntry msgCtxt;
  CStrEntry msgID;
  CStrEntry msgStr;
  std::vector<CStrEntry> msgStrPlural;
};

class CPODocument
{
public:
  CPODocument();
  ~CPODocument();

  bool LoadFile(const std::string &pofilename);

  bool GetNextEntry();

  int GetEntryType() const {return m_Entry.Type;}

  uint32_t GetEntryID() const {return m_Entry.xID;}

  void ParseEntry(bool bisSourceLang);

  const std::string& GetMsgctxt() const {return m_Entry.msgCtxt.Str;}

  const std::string& GetMsgid() const {return m_Entry.msgID.Str;}

  const std::string& GetMsgstr() const {return m_Entry.msgStr.Str;}

  const std::string& GetPlurMsgstr (size_t plural) const;

protected:

  std::string UnescapeString(const std::string &strInput);

  bool FindLineStart(const std::string &strToFind, size_t &FoundPos);

  void GetString(CStrEntry &strEntry);

  bool ParseNumID();

  void ConvertLineEnds(const std::string &filename);

  // Temporary string buffer to read file in.
  std::string m_strBuffer;
  // Size of the string buffer.
  size_t m_POfilelength;

  // Current cursor position in m_strBuffer.
  size_t m_CursorPos;
  // The next PO entry position in m_strBuffer.
  size_t m_nextEntryPos;

  // Variable to hold all data of currently processed entry.
  CPOEntry m_Entry;
};