File: catalog_parser.h

package info (click to toggle)
opencpn 5.2.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 101,540 kB
  • sloc: ansic: 414,598; cpp: 253,008; xml: 83,748; sh: 409; python: 353; makefile: 110; javascript: 87; perl: 83
file content (103 lines) | stat: -rw-r--r-- 3,377 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/******************************************************************************
 *
 * Project:  OpenCPN
 *
 ***************************************************************************
 *   Copyright (C) 2019 Alec Leamas                                        *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 ***************************************************************************
 */
#ifndef CATALOG_PARSER_H__
#define CATALOG_PARSER_H__

#include <memory>
#include <string>
#include <vector>

/**
 *  Datatypes and a single method to parse ocpn-plugins.xml XML data.
 */

/** Overall metadata for the set of plugins used. */
struct CatalogData {
    std::string version;
    std::string date;
    bool undef;
    CatalogData() : undef(true) {}
};


/** Plugin metadata, reflects the xml format directly. */
struct PluginMetadata {
    std::string name;
    std::string version;
    std::string release;
    std::string summary;

    std::string api_version;
    std::string author;
    std::string description;
    std::string git_commit ;
    std::string git_date;
    std::string source;
    std::string tarball_url;
    std::string target;
    std::string target_version;
    std::string target_arch;
    std::string info_url;
    std::string meta_url;

    bool openSource;

    bool readonly;                // Can plugin be removed?
    int ix;                       // Index in list of installed or available.
    void clear() { *this = PluginMetadata(); }
    std::string key() const
    {
       return std::string(name) + version + release + target + target_version;
    }


    PluginMetadata() : openSource(true), readonly(true), ix(-1) {}
};


/**
 * The result from parsing the xml catalog i. e., ocpn-plugins.xml.
 */
struct catalog_ctx {
    // list of plugins parsed
    std::vector<PluginMetadata> plugins;

    // list meta-urls found when parsing last plugin.
    std::vector<std::string> meta_urls;

    std::string version;
    std::string date;

    // Internal data used while parsing, undefined on exit.
    std::unique_ptr<PluginMetadata> plugin;
    std::string buff;
    std::string meta_url;
    int depth;
    catalog_ctx(): depth(0) {}
};


bool ParseCatalog(const std::string xml, catalog_ctx* ctx);

#endif  // CATALOG_PARSER_H__