luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refactoring of the editor hooks API

This commit is contained in:
Matthias Koefferlein 2024-03-30 20:53:43 +01:00
parent b4d1a4a954
commit f087a579af
4 changed files with 195 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/edt/edt/edtEditorHooks.h
View File

@ -37,10 +37,18 @@
namespace lay
{
class CellViewRef;
class LayoutViewBase;
class LayerProperties;
class ObjectInstPath;
}
namespace db
{
class Instance;
class Shape;
}
namespace edt
{
@ -54,7 +62,8 @@ namespace edt
*
* 1. Object Creation
*
* begin_create { begin_new_objects { create } end_new_objects } [ commit_create ] end_create
* begin_create_shapes { begin_new_shapes { create_shape } end_new_shapes } [ commit_shapes ] end_create_shapes
* begin_create_instances { begin_new_instances { create_instance } end_new_instances } [ commit_instances ] end_create_instances
*
* 2. Modification (i.e. partial edit)
*
@ -85,13 +94,21 @@ public:
*/
virtual ~EditorHooks ();
// creation protocol
virtual void begin_create (lay::LayoutViewBase * /*view*/) { }
virtual void begin_new_objects () { }
virtual void create (const lay::ObjectInstPath & /*object*/, const db::CplxTrans & /*view_trans*/) { }
virtual void end_new_objects () { }
virtual void commit_create () { }
virtual void end_create () { }
// shape creation protocol
virtual void begin_create_shapes (lay::CellViewRef & /*cv*/, const lay::LayerProperties & /*layer*/) { }
virtual void begin_new_shapes () { }
virtual void create_shape (const db::Shape & /*shape*/, const db::CplxTrans & /*view_trans*/) { }
virtual void end_new_shapes () { }
virtual void commit_shapes () { }
virtual void end_create_shapes () { }
// instance creation protocol
virtual void begin_create_instances (lay::CellViewRef & /*cv*/) { }
virtual void begin_new_instances () { }
virtual void create_instance (const db::Instance & /*instance*/, const db::CplxTrans & /*view_trans*/) { }
virtual void end_new_instances () { }
virtual void commit_instances () { }
virtual void end_create_instances () { }
// modification protocol
virtual void begin_modify (lay::LayoutViewBase * /*view*/) { }
@ -265,7 +282,7 @@ void call_editor_hooks (const tl::weak_collection<EditorHooks> &hooks, void (Edi
template <class A1, class A2, class A3>
inline
void call_editor_hooks (const tl::weak_collection<EditorHooks> &hooks, void (EditorHooks::*meth) (A1, A2), A1 a1, A2 a2, A3 a3)
void call_editor_hooks (const tl::weak_collection<EditorHooks> &hooks, void (EditorHooks::*meth) (A1, A2, A3), A1 a1, A2 a2, A3 a3)
{
for (auto h = hooks.begin (); h != hooks.end (); ++h) {
try {

75
src/edt/edt/edtServiceImpl.cc
View File

@ -408,45 +408,30 @@ ShapeEditService::open_editor_hooks ()
technology = mp_layout->technology ()->name ();
}
// NOTE: this is a kind of hack - as we want to present the new shape in some
// natural habitat (aka Shapes), we create an artificial Shapes container for holding the
// temporary object.
m_tmp_shapes.reset (new db::Shapes (0, mp_cell, true));
m_editor_hooks = edt::EditorHooks::get_editor_hooks (technology);
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::begin_create, view ());
lay::CellViewRef cv_ref (view ()->cellview_ref (m_cv_index));
call_editor_hooks<lay::CellViewRef &, const lay::LayerProperties &> (m_editor_hooks, &edt::EditorHooks::begin_create_shapes, cv_ref, *view ()->current_layer ());
}
void
ShapeEditService::close_editor_hooks (bool with_commit)
{
if (with_commit) {
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::commit_create);
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::commit_shapes);
}
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::end_create);
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::end_create_shapes);
m_editor_hooks.clear ();
m_tmp_shapes.reset (0);
}
template <class Shape>
void
ShapeEditService::deliver_shape_to_hooks (const Shape &shape)
{
if (! mp_cell || ! m_tmp_shapes.get ()) {
return;
}
m_tmp_shapes->clear ();
db::Shape s = m_tmp_shapes->insert (shape);
lay::ObjectInstPath path;
path.set_cv_index (m_cv_index);
path.set_layer (m_layer);
path.set_topcell (mp_cell->cell_index ());
path.set_shape (s);
call_editor_hooks<const lay::ObjectInstPath &, const db::CplxTrans &> (m_editor_hooks, &edt::EditorHooks::create, path, trans ().inverted ());
db::Shapes tmp (true);
db::Shape s = tmp.insert (shape);
call_editor_hooks<const db::Shape &, const db::CplxTrans &> (m_editor_hooks, &edt::EditorHooks::create_shape, s, trans ().inverted ());
}
// explicit instantiations
@ -797,13 +782,13 @@ PolygonService::update_marker ()
// call hooks with new shape
if (! editor_hooks ().empty ()) {
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_shapes);
try {
deliver_shape_to_hooks (get_polygon (true));
} catch (...) {
// ignore exceptions
}
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_shapes);
}
}
@ -863,13 +848,13 @@ BoxService::update_marker ()
// call hooks with new shape
if (! editor_hooks ().empty ()) {
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_shapes);
try {
deliver_shape_to_hooks (get_box ());
} catch (...) {
// ignore exceptions
}
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_shapes);
}
}
@ -974,13 +959,13 @@ PointService::update_marker ()
// call hooks with new shape
if (! editor_hooks ().empty ()) {
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_shapes);
try {
deliver_shape_to_hooks (get_point ());
} catch (...) {
// ignore exceptions
}
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_shapes);
}
}
@ -1091,13 +1076,13 @@ TextService::update_marker ()
// call hooks with new shape
if (! editor_hooks ().empty ()) {
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_shapes);
try {
deliver_shape_to_hooks (get_text ());
} catch (...) {
// ignore exceptions
}
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_shapes);
}
}
@ -1394,13 +1379,13 @@ PathService::update_marker ()
// call hooks with new shape
if (! editor_hooks ().empty ()) {
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_shapes);
try {
deliver_shape_to_hooks (get_path ());
} catch (...) {
// ignore exceptions
}
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_shapes);
}
}
@ -2269,7 +2254,7 @@ InstService::update_marker ()
// call hooks with new shape
if (! editor_hooks ().empty ()) {
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::begin_new_instances);
try {
@ -2278,18 +2263,12 @@ InstService::update_marker ()
db::CellInstArray inst;
if (cv.is_valid () && get_inst (inst)) {
// Note: we create a temporary instance collection and a temporary
// ObjectInstPath object there, so
// Note: the instance collection is temporary
db::Instances instances (cv.cell ());
lay::ObjectInstPath path;
path.set_cv_index (m_cv_index);
path.set_topcell (cv.cell_index ());
path.add_path (db::InstElement (instances.insert (inst)));
db::Instance i = instances.insert (inst);
db::CplxTrans view_trans = db::CplxTrans (cv->layout ().dbu ()) * m_trans;
call_editor_hooks<const lay::ObjectInstPath &, const db::CplxTrans &> (m_editor_hooks, &edt::EditorHooks::create, path, view_trans);
call_editor_hooks<const db::Instance &, const db::CplxTrans &> (m_editor_hooks, &edt::EditorHooks::create_instance, i, view_trans);
}
@ -2297,7 +2276,7 @@ InstService::update_marker ()
// ignore exceptions
}
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_objects);
call_editor_hooks (editor_hooks (), &edt::EditorHooks::end_new_instances);
}
}
@ -2345,16 +2324,18 @@ InstService::open_editor_hooks ()
}
m_editor_hooks = edt::EditorHooks::get_editor_hooks (technology);
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::begin_create, view ());
lay::CellViewRef cv_ref (view ()->cellview_ref (m_cv_index));
call_editor_hooks<lay::CellViewRef &> (m_editor_hooks, &edt::EditorHooks::begin_create_instances, cv_ref);
}
void
InstService::close_editor_hooks (bool with_commit)
{
if (with_commit) {
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::commit_create);
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::commit_instances);
}
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::end_create);
call_editor_hooks (m_editor_hooks, &edt::EditorHooks::end_create_instances);
m_editor_hooks.clear ();
}

1
src/edt/edt/edtServiceImpl.h
View File

@ -89,7 +89,6 @@ private:
db::Layout *mp_layout;
combine_mode_type m_combine_mode;
tl::weak_collection<edt::EditorHooks> m_editor_hooks;
std::unique_ptr<db::Shapes> m_tmp_shapes;
void update_edit_layer (const lay::LayerPropertiesConstIterator &iter);
};

191
src/edt/edt/gsiDeclEdtEditorHooks.cc
View File

@ -39,57 +39,111 @@ public:
// .. nothing yet ..
}
virtual void begin_create (lay::LayoutViewBase *view)
virtual void begin_create_shapes (lay::CellViewRef &cv, const lay::LayerProperties &layer)
{
if (f_begin_create.can_issue ()) {
f_begin_create.issue<edt::EditorHooks, lay::LayoutViewBase *> (&edt::EditorHooks::begin_create, view);
if (f_begin_create_shapes.can_issue ()) {
f_begin_create_shapes.issue<edt::EditorHooks, lay::CellViewRef &, const lay::LayerProperties &> (&edt::EditorHooks::begin_create_shapes, cv, layer);
} else {
edt::EditorHooks::begin_create (view);
edt::EditorHooks::begin_create_shapes (cv, layer);
}
}
virtual void begin_new_objects ()
virtual void begin_new_shapes ()
{
if (f_begin_new_objects.can_issue ()) {
f_begin_new_objects.issue<edt::EditorHooks> (&edt::EditorHooks::begin_new_objects);
if (f_begin_new_shapes.can_issue ()) {
f_begin_new_shapes.issue<edt::EditorHooks> (&edt::EditorHooks::begin_new_shapes);
} else {
edt::EditorHooks::begin_new_objects ();
edt::EditorHooks::begin_new_shapes ();
}
}
virtual void create (const lay::ObjectInstPath &object, const db::CplxTrans &view_trans)
virtual void create_shape (const db::Shape &shape, const db::CplxTrans &view_trans)
{
if (f_create.can_issue ()) {
f_create.issue<edt::EditorHooks, const lay::ObjectInstPath &, const db::CplxTrans &> (&edt::EditorHooks::create, object, view_trans);
if (f_create_shape.can_issue ()) {
f_create_shape.issue<edt::EditorHooks, const db::Shape &, const db::CplxTrans &> (&edt::EditorHooks::create_shape, shape, view_trans);
} else {
edt::EditorHooks::create (object, view_trans);
edt::EditorHooks::create_shape (shape, view_trans);
}
}
virtual void end_new_objects ()
virtual void end_new_shapes ()
{
if (f_end_new_objects.can_issue ()) {
f_end_new_objects.issue<edt::EditorHooks> (&edt::EditorHooks::end_new_objects);
if (f_end_new_shapes.can_issue ()) {
f_end_new_shapes.issue<edt::EditorHooks> (&edt::EditorHooks::end_new_shapes);
} else {
edt::EditorHooks::end_new_objects ();
edt::EditorHooks::end_new_shapes ();
}
}
virtual void commit_create ()
virtual void commit_shapes ()
{
if (f_commit_create.can_issue ()) {
f_commit_create.issue<edt::EditorHooks> (&edt::EditorHooks::commit_create);
if (f_commit_shapes.can_issue ()) {
f_commit_shapes.issue<edt::EditorHooks> (&edt::EditorHooks::commit_shapes);
} else {
edt::EditorHooks::commit_create ();
edt::EditorHooks::commit_shapes ();
}
}
virtual void end_create ()
virtual void end_create_shapes ()
{
if (f_end_create.can_issue ()) {
f_end_create.issue<edt::EditorHooks> (&edt::EditorHooks::end_create);
if (f_end_create_shapes.can_issue ()) {
f_end_create_shapes.issue<edt::EditorHooks> (&edt::EditorHooks::end_create_shapes);
} else {
edt::EditorHooks::end_create ();
edt::EditorHooks::end_create_shapes ();
}
}
virtual void begin_create_instances (lay::CellViewRef &cv)
{
if (f_begin_create_instances.can_issue ()) {
f_begin_create_instances.issue<edt::EditorHooks, lay::CellViewRef &> (&edt::EditorHooks::begin_create_instances, cv);
} else {
edt::EditorHooks::begin_create_instances (cv);
}
}
virtual void begin_new_instances ()
{
if (f_begin_new_instances.can_issue ()) {
f_begin_new_instances.issue<edt::EditorHooks> (&edt::EditorHooks::begin_new_instances);
} else {
edt::EditorHooks::begin_new_instances ();
}
}
virtual void create_instance (const db::Instance &object, const db::CplxTrans &view_trans)
{
if (f_create_instance.can_issue ()) {
f_create_instance.issue<edt::EditorHooks, const db::Instance &, const db::CplxTrans &> (&edt::EditorHooks::create_instance, object, view_trans);
} else {
edt::EditorHooks::create_instance (object, view_trans);
}
}
virtual void end_new_instances ()
{
if (f_end_new_instances.can_issue ()) {
f_end_new_instances.issue<edt::EditorHooks> (&edt::EditorHooks::end_new_instances);
} else {
edt::EditorHooks::end_new_instances ();
}
}
virtual void commit_instances ()
{
if (f_commit_instances.can_issue ()) {
f_commit_instances.issue<edt::EditorHooks> (&edt::EditorHooks::commit_instances);
} else {
edt::EditorHooks::commit_instances ();
}
}
virtual void end_create_instances ()
{
if (f_end_create_instances.can_issue ()) {
f_end_create_instances.issue<edt::EditorHooks> (&edt::EditorHooks::end_create_instances);
} else {
edt::EditorHooks::end_create_instances ();
}
}
@ -201,12 +255,19 @@ public:
}
}
gsi::Callback f_begin_create;
gsi::Callback f_begin_new_objects;
gsi::Callback f_create;
gsi::Callback f_end_new_objects;
gsi::Callback f_commit_create;
gsi::Callback f_end_create;
gsi::Callback f_begin_create_shapes;
gsi::Callback f_begin_new_shapes;
gsi::Callback f_create_shape;
gsi::Callback f_end_new_shapes;
gsi::Callback f_commit_shapes;
gsi::Callback f_end_create_shapes;
gsi::Callback f_begin_create_instances;
gsi::Callback f_begin_new_instances;
gsi::Callback f_create_instance;
gsi::Callback f_end_new_instances;
gsi::Callback f_commit_instances;
gsi::Callback f_end_create_instances;
gsi::Callback f_begin_modify;
gsi::Callback f_begin_modifications;
@ -229,34 +290,64 @@ static void register_editor_hooks (EditorHooksImpl *hooks, const std::string &na
}
gsi::Class<EditorHooksImpl> decl_EditorHooks ("lay", "EditorHooks",
gsi::callback ("begin_create", &EditorHooksImpl::begin_create, &EditorHooksImpl::f_begin_create,
"@brief Creation protocol - begin session\n"
"This method is called to initiate an object creation session. The session is ended with "
"\\end_create. Between these calls, new objects are announced with \\begin_new_objects, "
"\\create and \\end_new_objects calls. These calls are repeated to indicate changes in the objects "
gsi::callback ("begin_create_shapes", &EditorHooksImpl::begin_create_shapes, &EditorHooksImpl::f_begin_create_shapes, gsi::arg ("cellview"), gsi::arg ("layer"),
"@brief Shape creation protocol - begin session\n"
"This method is called to initiate a shape creation session. The session is ended with "
"\\end_create_shapes. Between these calls, new objects are announced with \\begin_new_shapes, "
"\\create_shape and \\end_new_shapes calls. These calls are repeated to indicate changes in the objects "
"created.\n"
"\n"
"\\commit_create is called once before \\end_create to indicate that the last set of "
"objects are committed to the database."
"\\commit_shapes is called once before \\end_create_shapes to indicate that the last set of "
"objects is committed to the database."
) +
gsi::callback ("begin_new_objects", &EditorHooksImpl::begin_new_objects, &EditorHooksImpl::f_begin_new_objects,
"@brief Creation protocol - begin new objects\n"
gsi::callback ("begin_new_shapes", &EditorHooksImpl::begin_new_shapes, &EditorHooksImpl::f_begin_new_shapes,
"@brief Shape creation protocol - begin new shapes\n"
"See \\begin_create_shapes for a description of the protocol."
) +
gsi::callback ("create_shape", &EditorHooksImpl::create_shape, &EditorHooksImpl::f_create_shape, gsi::arg ("shape"), gsi::arg ("view_trans"),
"@brief Shape creation protocol - indicate a new object\n"
"See \\begin_create_shapes for a description of the protocol."
) +
gsi::callback ("end_new_shapes", &EditorHooksImpl::end_new_shapes, &EditorHooksImpl::f_end_new_shapes,
"@brief Shape creation protocol - finish list of new shapes\n"
"See \\begin_create_shapes for a description of the protocol."
) +
gsi::callback ("commit_shapes", &EditorHooksImpl::commit_shapes, &EditorHooksImpl::f_commit_shapes,
"@brief Shape creation protocol - commit new objects\n"
"See \\begin_create_shapes for a description of the protocol."
) +
gsi::callback ("end_create_shapes", &EditorHooksImpl::end_create_shapes, &EditorHooksImpl::f_end_create_shapes,
"@brief Shape creation protocol - finish session\n"
"See \\begin_create for a description of the protocol."
) +
gsi::callback ("create", &EditorHooksImpl::create, &EditorHooksImpl::f_create, gsi::arg ("object"), gsi::arg ("view_trans"),
"@brief Creation protocol - indicate a new object\n"
"See \\begin_create for a description of the protocol."
gsi::callback ("begin_create_instances", &EditorHooksImpl::begin_create_instances, &EditorHooksImpl::f_begin_create_instances, gsi::arg ("cellview"),
"@brief Instance creation protocol - begin session\n"
"This method is called to initiate an instance creation session. The session is ended with "
"\\end_create_instances. Between these calls, new objects are announced with \\begin_new_instances, "
"\\create_instance and \\end_new_instances calls. These calls are repeated to indicate changes in the objects "
"created.\n"
"\n"
"\\commit_instances is called once before \\end_create_instances to indicate that the last set of "
"objects is committed to the database."
) +
gsi::callback ("end_new_objects", &EditorHooksImpl::end_new_objects, &EditorHooksImpl::f_end_new_objects,
"@brief Creation protocol - finish list of new objects\n"
"See \\begin_create for a description of the protocol."
gsi::callback ("begin_new_instances", &EditorHooksImpl::begin_new_instances, &EditorHooksImpl::f_begin_new_instances,
"@brief Instance creation protocol - begin new instances\n"
"See \\begin_create_instances for a description of the protocol."
) +
gsi::callback ("commit_create", &EditorHooksImpl::commit_create, &EditorHooksImpl::f_commit_create,
"@brief Creation protocol - commit new objects\n"
"See \\begin_create for a description of the protocol."
gsi::callback ("create_instance", &EditorHooksImpl::create_instance, &EditorHooksImpl::f_create_instance, gsi::arg ("instance"), gsi::arg ("view_trans"),
"@brief Instance creation protocol - indicate a new object\n"
"See \\begin_create_instances for a description of the protocol."
) +
gsi::callback ("end_create", &EditorHooksImpl::end_create, &EditorHooksImpl::f_end_create,
"@brief Creation protocol - finish session\n"
gsi::callback ("end_new_instances", &EditorHooksImpl::end_new_instances, &EditorHooksImpl::f_end_new_instances,
"@brief Instance creation protocol - finish list of new instances\n"
"See \\begin_create_instances for a description of the protocol."
) +
gsi::callback ("commit_instances", &EditorHooksImpl::commit_instances, &EditorHooksImpl::f_commit_instances,
"@brief Instance creation protocol - commit new objects\n"
"See \\begin_create_instances for a description of the protocol."
) +
gsi::callback ("end_create_instances", &EditorHooksImpl::end_create_instances, &EditorHooksImpl::f_end_create_instances,
"@brief Instance creation protocol - finish session\n"
"See \\begin_create for a description of the protocol."
) +
gsi::callback ("begin_modify", &EditorHooksImpl::begin_modify, &EditorHooksImpl::f_begin_modify, gsi::arg ("view"),