klayout/src/plugins/streamers/oasis/db_plugin/dbOASISReader.h

288 lines
8.9 KiB
C++

/*
KLayout Layout Viewer
Copyright (C) 2006-2025 Matthias Koefferlein
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 St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef HDR_dbOASISReader
#define HDR_dbOASISReader
#include "dbPluginCommon.h"
#include "dbLayout.h"
#include "dbReader.h"
#include "dbTypes.h"
#include "dbOASIS.h"
#include "dbOASISFormat.h"
#include "dbStreamLayers.h"
#include "dbPropertiesRepository.h"
#include "dbCommonReader.h"
#include "tlException.h"
#include "tlInternational.h"
#include "tlProgress.h"
#include "tlString.h"
#include "tlStream.h"
#include <map>
#include <set>
namespace db
{
/**
* @brief Generic base class of OASIS reader exceptions
*/
class DB_PLUGIN_PUBLIC OASISReaderException
: public ReaderException
{
public:
OASISReaderException (const std::string &msg, size_t p, const std::string &cell, const std::string &source)
: ReaderException (tl::sprintf (tl::to_string (tr ("%s (position=%ld, cell=%s), in file: %s")), msg, p, cell, source))
{ }
};
/**
* @brief The OASIS format stream reader
*/
class DB_PLUGIN_PUBLIC OASISReader
: public CommonReader,
public OASISDiagnostics
{
public:
typedef std::vector<tl::Variant> property_value_list;
/**
* @brief Construct a stream reader object
*
* @param s The stream delegate from which to read stream data from
*/
OASISReader (tl::InputStream &s);
/**
* @brief Destructor
*/
~OASISReader ();
/**
* @brief Format
*/
virtual const char *format () const { return "OASIS"; }
protected:
/**
* @brief Issue an error with positional information
*
* Reimplements OASISDiagnostics
*/
virtual void error (const std::string &txt);
/**
* @brief Issue a warning with positional information
*
* Reimplements OASISDiagnostics
*/
virtual void warn (const std::string &txt, int warn_level = 1);
virtual void common_reader_error (const std::string &msg) { error (msg); }
virtual void common_reader_warn (const std::string &msg, int warn_level = 1) { warn (msg, warn_level); }
virtual void init (const LoadLayoutOptions &options);
virtual void do_read (db::Layout &layout);
private:
typedef db::coord_traits<db::Coord>::distance_type distance_type;
enum TableMode
{
NotInTable,
InCELLNAME,
InPROPNAME,
InPROPSTRING,
InTEXTSTRING,
InLAYERNAME
};
tl::InputStream &m_stream;
tl::AbsoluteProgress m_progress;
std::string m_cellname;
int m_expect_strict_mode;
size_t m_first_cellname;
size_t m_first_propname;
size_t m_first_propstring;
size_t m_first_textstring;
size_t m_first_layername;
TableMode m_in_table;
size_t m_table_cellname;
size_t m_table_propname;
size_t m_table_propstring;
size_t m_table_textstring;
size_t m_table_layername;
size_t m_table_start;
modal_variable<Repetition> mm_repetition;
modal_variable<db::cell_index_type> mm_placement_cell;
modal_variable<db::Coord> mm_placement_x;
modal_variable<db::Coord> mm_placement_y;
modal_variable<uint32_t> mm_layer;
modal_variable<uint32_t> mm_datatype;
modal_variable<uint32_t> mm_textlayer;
modal_variable<uint32_t> mm_texttype;
modal_variable<db::Coord> mm_text_x;
modal_variable<db::Coord> mm_text_y;
modal_variable<std::string> mm_text_string;
modal_variable<uint64_t> mm_text_string_id;
modal_variable<db::Coord> mm_geometry_x;
modal_variable<db::Coord> mm_geometry_y;
modal_variable<distance_type> mm_geometry_w;
modal_variable<distance_type> mm_geometry_h;
modal_variable< std::vector<db::Point> > mm_polygon_point_list;
modal_variable<distance_type> mm_path_halfwidth;
modal_variable<db::Coord> mm_path_start_extension;
modal_variable<db::Coord> mm_path_end_extension;
modal_variable< std::vector<db::Point> > mm_path_point_list;
modal_variable<uint32_t> mm_ctrapezoid_type;
modal_variable<distance_type> mm_circle_radius;
modal_variable<db::property_names_id_type> mm_last_property_name;
modal_variable<bool> mm_last_property_is_sprop;
modal_variable<property_value_list> mm_last_value_list;
std::map <uint64_t, db::properties_id_type> m_cellname_properties;
std::map <uint64_t, std::string> m_textstrings;
std::map <uint64_t, const db::StringRef *> m_text_forward_references;
std::map <uint64_t, std::string> m_propstrings;
std::map <uint64_t, std::string> m_propnames;
std::map <db::cell_index_type, std::vector<tl::Variant> > m_context_strings_per_cell;
tl::vector<db::CellInstArray> m_instances;
tl::vector<db::CellInstArrayWithProperties> m_instances_with_props;
bool m_read_texts;
bool m_read_properties;
bool m_read_all_properties;
std::map <uint64_t, db::property_names_id_type> m_propname_forward_references;
std::map <uint64_t, std::string> m_propvalue_forward_references;
std::map <db::properties_id_type, std::set<db::Shapes *> > m_forward_properties_for_shapes;
std::map <db::properties_id_type, std::set<db::Instances *> > m_forward_properties_for_instances;
std::map <db::cell_index_type, db::PropertiesSet> m_future_cell_properties;
std::list<db::PropertiesSet> m_fwd_properties;
db::property_names_id_type m_s_gds_property_name_id;
db::property_names_id_type m_klayout_context_property_name_id;
void do_read_cell (db::cell_index_type cell_index, db::Layout &layout);
void do_read_placement (unsigned char r,
bool xy_absolute,
db::Layout &layout,
tl::vector<db::CellInstArray> &instances,
tl::vector<db::CellInstArrayWithProperties> &instances_with_props);
void do_read_text (bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void do_read_rectangle (bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void do_read_polygon (bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void do_read_path (bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void do_read_trapezoid (unsigned char r, bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void do_read_ctrapezoid (bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void do_read_circle (bool xy_absolute,db::cell_index_type cell_index, db::Layout &layout);
void reset_modal_variables ();
void mark_start_table ();
void read_offset_table ();
bool read_repetition ();
void read_pointlist (modal_variable <std::vector <db::Point> > &pointlist, bool for_polygon);
void read_properties ();
void store_last_properties (db::PropertiesSet &properties, bool ignore_special, bool with_context_props = false);
std::pair <bool, db::properties_id_type> read_element_properties (bool ignore_special);
void replace_forward_references_in_variant (tl::Variant &v);
void extract_context_strings (db::PropertiesSet &properties, std::vector<tl::Variant> &context_strings);
bool has_forward_refs (const db::PropertiesSet &properties);
db::properties_id_type make_forward_properties_id (const db::PropertiesSet &properties);
const db::PropertiesSet &forward_properties (db::properties_id_type id) const;
bool is_forward_properties_id (db::properties_id_type id) const;
void register_forward_property_for_shape (const db::Shape &shape);
void register_forward_property_for_instance (const db::Instance &instance);
void resolve_forward_references (db::PropertiesSet &properties);
unsigned char get_byte ()
{
unsigned char *b = (unsigned char *) m_stream.get (1);
if (! b) {
error (tl::to_string (tr ("Unexpected end-of-file")));
return 0;
} else {
return *b;
}
}
int64_t get_int64 ();
uint64_t get_uint64 ();
uint64_t get_uint64_for_divider ();
int32_t get_int32 ();
uint32_t get_uint32 ();
void get (int64_t &l)
{
l = get_int64 ();
}
void get_size (size_t &l)
{
l = get_uint64 ();
}
void get (uint64_t &l)
{
l = get_uint64 ();
}
void get (int32_t &l)
{
l = get_int32 ();
}
void get (uint32_t &l)
{
l = get_uint32 ();
}
void get (double &d)
{
d = get_real ();
}
std::string get_str ();
void get_str (std::string &s);
double get_real ();
db::Vector get_gdelta (int64_t grid = 1);
db::Vector get_3delta (int64_t grid = 1);
db::Vector get_2delta (int64_t grid = 1);
db::Coord get_coord (int64_t grid = 1);
db::Coord get_ucoord (uint64_t grid = 1);
distance_type get_ucoord_as_distance (uint64_t grid = 1);
};
}
#endif