KiCad PCB EDA Suite
ptree.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright (C) 2013-2020 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef PTREE_H_
26#define PTREE_H_
27
28/*
29Implement "KiCad s-expression" support for boost::property_tree's ptree, the 8
30bit string version of property_tree. The ram resident structure of the ptree is
31mostly compatible with one created using the xml_parser from
32boost::property_tree, with slight differences in the way atoms are stored. The
33result is you can use Format() to convert from xml to s-expression, but not the
34other way around. You can write a simple s-expression beautifier in just a few
35lines of code.
36
37The main value however is the s-expression parser, i.e. Scan(), which is an
38alternative to crafting a custom recursive descent parser for a particular
39grammar. The tipping point depends on whether you want to read only a small
40portion of a much larger document. If so, then using the ptree will likely be a
41"faster to code" route. Documentation on how to navigate a ptree can be found on
42the boost website and there are a number of examples in the
43pcbnew/eagle_plugin.cpp file in this project. Powerful path navigation support
44makes it easy to extract a subset of a ptree.
45*/
46
47
48#include <boost/property_tree/ptree_fwd.hpp>
49#include <richio.h>
50#include <dsnlexer.h>
51
52typedef boost::property_tree::ptree PTREE;
53typedef const PTREE CPTREE;
54typedef boost::property_tree::ptree_error PTREE_ERROR;
55
85void Scan( PTREE* aTree, DSNLEXER* aLexer );
86
90void Format( OUTPUTFORMATTER* out, int aNestLevel, int aCtl, const CPTREE& aTree );
91
92#endif // PTREE_H_
Implement a lexical analyzer for the SPECCTRA DSN file format.
Definition: dsnlexer.h:79
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:310
const PTREE CPTREE
Definition: ptree.h:53
boost::property_tree::ptree_error PTREE_ERROR
Definition: ptree.h:54
boost::property_tree::ptree PTREE
Definition: ptree.h:52
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
void Scan(PTREE *aTree, DSNLEXER *aLexer)
Fill an empty PTREE with information from a KiCad s-expression stream.
Definition: ptree.cpp:86