mirror of https://github.com/KLayout/klayout.git
142 lines
3.6 KiB
C++
142 lines
3.6 KiB
C++
|
|
/*
|
|
|
|
KLayout Layout Viewer
|
|
Copyright (C) 2006-2020 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_dbWriterTools
|
|
#define HDR_dbWriterTools
|
|
|
|
#include "dbCommon.h"
|
|
|
|
#include "dbTypes.h"
|
|
|
|
#include <map>
|
|
#include <set>
|
|
#include <string>
|
|
|
|
namespace db
|
|
{
|
|
|
|
class Layout;
|
|
|
|
/**
|
|
* @brief A class for cell name transformations
|
|
*
|
|
* The default settings are: allow upper and lower case characters and digits.
|
|
* Replace all other characters with a '$'.
|
|
*/
|
|
class DB_PUBLIC WriterCellNameMap
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Create a cell name map with unlimited cell name length
|
|
*/
|
|
WriterCellNameMap ();
|
|
|
|
/**
|
|
* @brief Create a cell name map with the specified maximum cell name length
|
|
*/
|
|
WriterCellNameMap (size_t max_cellname_length);
|
|
|
|
/**
|
|
* @brief Specify the replacement characters.
|
|
*
|
|
* This method specifies the replacement character which will replace all
|
|
* non-specified characters.
|
|
* If the replacement character is 0, characters not allowed are ignored.
|
|
* If the replacement character is \t, a hex sequence will be inserted for
|
|
* the original characters.
|
|
*/
|
|
void replacement (char c);
|
|
|
|
/**
|
|
* @brief Specify character transformation
|
|
*
|
|
* Replaces all of the characters in the first string by the ones in the second
|
|
* string. Both strings must have the same length.
|
|
* By specifying a replacement character of \t, a hex sequence will be inserted for
|
|
* the original characters.
|
|
*/
|
|
void transform (const char *what, const char *with);
|
|
|
|
/**
|
|
* @brief Disallows all characters
|
|
*/
|
|
void disallow_all ();
|
|
|
|
/**
|
|
* @brief Allows the specified characters
|
|
*
|
|
* @param what The characters to allow
|
|
*/
|
|
void allow (const char *what)
|
|
{
|
|
transform (what, what);
|
|
}
|
|
|
|
/**
|
|
* @brief Allows all printing characters (ASCII 0x21..0x7f)
|
|
*/
|
|
void allow_all_printing ();
|
|
|
|
/**
|
|
* @brief Allow standard characters
|
|
*
|
|
* Allows upper case, lower case, digits, the underscore and the dollar character
|
|
* or disallow them. By default, all these characters are allowed.
|
|
*/
|
|
void allow_standard (bool upper_case, bool lower_case, bool digits);
|
|
|
|
/**
|
|
* @brief Insert all cells from the given layout
|
|
*/
|
|
void insert (const db::Layout &layout);
|
|
|
|
/**
|
|
* @brief Insert the given cell name for the given cell id
|
|
*
|
|
* The name is checked for length and compliance with the character map.
|
|
* If the name does not comply, it is adjusted acoordingly.
|
|
*/
|
|
void insert (db::cell_index_type id, const std::string &cell_name);
|
|
|
|
/**
|
|
* @brief Obtain the output cell name for a given cell id
|
|
*
|
|
* The output cell name is guaranteed to be compliant with the max cell name length
|
|
* and the character transformation rules.
|
|
*/
|
|
const std::string &cell_name (db::cell_index_type id) const;
|
|
|
|
private:
|
|
std::map <db::cell_index_type, std::string> m_map;
|
|
std::set <std::string> m_cell_names;
|
|
char m_character_trans [256];
|
|
char m_default_char;
|
|
size_t m_max_cellname_length;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|