From c7fe1cb1891963ec0b1225aafc688652f1dbc9f7 Mon Sep 17 00:00:00 2001
From: Matthias Koefferlein <matthias@koefferlein.de>
Date: Sun, 16 Jun 2019 16:48:30 +0200
Subject: [PATCH] Fixed #275 (don't write PCell context with OASIS)

The ability to disable PCell context on OASIS output
with the "write_context_info" option was added.
---
 .../oasis/db_plugin/dbOASISWriter.cc          |  60 +++---
 .../oasis/unit_tests/dbOASISWriter.cc         | 187 ++++++++++++------
 testdata/oasis/dbOASISWriter119_au.gds        | Bin 0 -> 3838 bytes
 testdata/oasis/pcell_test.gds                 | Bin 0 -> 4898 bytes
 4 files changed, 166 insertions(+), 81 deletions(-)
 create mode 100644 testdata/oasis/dbOASISWriter119_au.gds
 create mode 100644 testdata/oasis/pcell_test.gds

diff --git a/src/plugins/streamers/oasis/db_plugin/dbOASISWriter.cc b/src/plugins/streamers/oasis/db_plugin/dbOASISWriter.cc
index 76197bc28..15628938a 100644
--- a/src/plugins/streamers/oasis/db_plugin/dbOASISWriter.cc
+++ b/src/plugins/streamers/oasis/db_plugin/dbOASISWriter.cc
@@ -1343,20 +1343,24 @@ OASISWriter::write (db::Layout &layout, tl::OutputStream &stream, const db::Save
 
     }
 
-    //  emit property name required for the PCell context information
-    std::vector <std::string> context_prop_strings;
-    for (std::vector<db::cell_index_type>::const_iterator cell = cells.begin (); cell != cells.end (); ++cell) {
+    if (options.write_context_info ()) {
 
-      const db::Cell &cref (layout.cell (*cell));
-      if (cref.is_proxy () && ! cref.is_top () && layout.get_context_info (*cell, context_prop_strings)) {
+      //  emit property name required for the PCell context information
+      std::vector <std::string> context_prop_strings;
+      for (std::vector<db::cell_index_type>::const_iterator cell = cells.begin (); cell != cells.end (); ++cell) {
+
+        const db::Cell &cref (layout.cell (*cell));
+        if (cref.is_proxy () && ! cref.is_top () && layout.get_context_info (*cell, context_prop_strings)) {
+
+          if (m_propnames.insert (std::make_pair (std::string (klayout_context_name), m_propname_id)).second) {
+            begin_table (propnames_table_pos);
+            write_record_id (7);
+            write_nstring (klayout_context_name);
+            ++m_propname_id;
+          }
+          break;
 
-        if (m_propnames.insert (std::make_pair (std::string (klayout_context_name), m_propname_id)).second) {
-          begin_table (propnames_table_pos);
-          write_record_id (7);
-          write_nstring (klayout_context_name);
-          ++m_propname_id;
         }
-        break;
 
       }
 
@@ -1422,25 +1426,29 @@ OASISWriter::write (db::Layout &layout, tl::OutputStream &stream, const db::Save
 
     }
 
-    //  emit property string id's required for the PCell context information
-    std::vector <std::string> context_prop_strings;
-    for (std::vector<db::cell_index_type>::const_iterator cell = cells.begin (); cell != cells.end (); ++cell) {
+    if (options.write_context_info ()) {
 
-      m_progress.set (mp_stream->pos ());
+      //  emit property string id's required for the PCell context information
+      std::vector <std::string> context_prop_strings;
+      for (std::vector<db::cell_index_type>::const_iterator cell = cells.begin (); cell != cells.end (); ++cell) {
 
-      const db::Cell &cref (layout.cell (*cell));
-      if (cref.is_proxy () && ! cref.is_top ()) {
+        m_progress.set (mp_stream->pos ());
 
-        context_prop_strings.clear ();
-        if (layout.get_context_info (*cell, context_prop_strings)) {
+        const db::Cell &cref (layout.cell (*cell));
+        if (cref.is_proxy () && ! cref.is_top ()) {
 
-          for (std::vector <std::string>::const_iterator c = context_prop_strings.begin (); c != context_prop_strings.end (); ++c) {
-            if (m_propstrings.insert (std::make_pair (*c, m_propstring_id)).second) {
-              begin_table (propstrings_table_pos);
-              write_record_id (9);
-              write_bstring (c->c_str ());
-              ++m_propstring_id;
+          context_prop_strings.clear ();
+          if (layout.get_context_info (*cell, context_prop_strings)) {
+
+            for (std::vector <std::string>::const_iterator c = context_prop_strings.begin (); c != context_prop_strings.end (); ++c) {
+              if (m_propstrings.insert (std::make_pair (*c, m_propstring_id)).second) {
+                begin_table (propstrings_table_pos);
+                write_record_id (9);
+                write_bstring (c->c_str ());
+                ++m_propstring_id;
+              }
             }
+
           }
 
         }
@@ -1604,7 +1612,7 @@ OASISWriter::write (db::Layout &layout, tl::OutputStream &stream, const db::Save
       }
 
       //  context information as property named KLAYOUT_CONTEXT
-      if (cref.is_proxy ()) {
+      if (cref.is_proxy () && options.write_context_info ()) {
 
         context_prop_strings.clear ();
 
diff --git a/src/plugins/streamers/oasis/unit_tests/dbOASISWriter.cc b/src/plugins/streamers/oasis/unit_tests/dbOASISWriter.cc
index 68bec61d0..13aef7df0 100644
--- a/src/plugins/streamers/oasis/unit_tests/dbOASISWriter.cc
+++ b/src/plugins/streamers/oasis/unit_tests/dbOASISWriter.cc
@@ -26,6 +26,8 @@
 #include "dbLayoutDiff.h"
 #include "dbWriter.h"
 #include "dbTextWriter.h"
+#include "dbLibraryProxy.h"
+#include "dbTestSupport.h"
 
 #include "tlUnitTest.h"
 
@@ -1258,61 +1260,6 @@ TEST(115)
   EXPECT_EQ (std::string (os.string ()), std::string (expected))
 }
 
-TEST(118)
-{
-  //  1x1 arrays (#902)
-  
-  db::Manager m;
-  db::Layout g (&m);
-
-  db::LayerProperties lp1;
-  lp1.layer = 1;
-  lp1.datatype = 0;
-
-  g.insert_layer (0, lp1);
-
-  db::Cell &c1 (g.cell (g.add_cell ()));
-  c1.shapes (0).insert (db::Box (100, 0, 100, 200));
-
-  db::Cell &c2 (g.cell (g.add_cell ()));
-  c2.insert (db::array <db::CellInst, db::Trans> (db::CellInst (c1.cell_index ()), db::Trans (), db::Vector (0, 1), db::Vector (1, 0), 1, 1));
-  c2.insert (db::array <db::CellInst, db::Trans> (db::CellInst (c1.cell_index ()), db::Trans (db::Vector (17, -42)), db::Vector (0, 1), db::Vector (1, 0), 1, 1));
-
-  std::string tmp_file = tl::TestBase::tmp_file ("tmp.oas");
-
-  {
-    tl::OutputStream out (tmp_file);
-    db::SaveLayoutOptions options;
-    options.set_format ("OASIS");
-    db::Writer writer (options);
-    writer.write (g, out);
-  }
-
-  tl::InputStream in (tmp_file);
-  db::Reader reader (in);
-  db::Layout gg;
-  reader.set_warnings_as_errors (true);
-  reader.read (gg);
-
-  const char *expected = 
-    "begin_lib 0.001\n"
-    "begin_cell {$1}\n"
-    "box 1 0 {100 0} {100 200}\n"
-    "end_cell\n"
-    "begin_cell {$2}\n"
-    "sref {$1} 0 0 1 {0 0}\n"
-    "sref {$1} 0 0 1 {17 -42}\n"
-    "end_cell\n"
-    "end_lib\n"
-    ;
-
-  tl::OutputStringStream os;
-  tl::OutputStream stream (os);
-  db::TextWriter textwriter (stream);
-  textwriter.write (gg);
-  EXPECT_EQ (std::string (os.string ()), std::string (expected))
-}
-
 TEST(116)
 {
   db::Manager m;
@@ -1728,3 +1675,133 @@ TEST(117)
   EXPECT_EQ (std::string (os.string ()), std::string (expected))
 }
 
+TEST(118)
+{
+  //  1x1 arrays (#902)
+
+  db::Manager m;
+  db::Layout g (&m);
+
+  db::LayerProperties lp1;
+  lp1.layer = 1;
+  lp1.datatype = 0;
+
+  g.insert_layer (0, lp1);
+
+  db::Cell &c1 (g.cell (g.add_cell ()));
+  c1.shapes (0).insert (db::Box (100, 0, 100, 200));
+
+  db::Cell &c2 (g.cell (g.add_cell ()));
+  c2.insert (db::array <db::CellInst, db::Trans> (db::CellInst (c1.cell_index ()), db::Trans (), db::Vector (0, 1), db::Vector (1, 0), 1, 1));
+  c2.insert (db::array <db::CellInst, db::Trans> (db::CellInst (c1.cell_index ()), db::Trans (db::Vector (17, -42)), db::Vector (0, 1), db::Vector (1, 0), 1, 1));
+
+  std::string tmp_file = tl::TestBase::tmp_file ("tmp.oas");
+
+  {
+    tl::OutputStream out (tmp_file);
+    db::SaveLayoutOptions options;
+    options.set_format ("OASIS");
+    db::Writer writer (options);
+    writer.write (g, out);
+  }
+
+  tl::InputStream in (tmp_file);
+  db::Reader reader (in);
+  db::Layout gg;
+  reader.set_warnings_as_errors (true);
+  reader.read (gg);
+
+  const char *expected =
+    "begin_lib 0.001\n"
+    "begin_cell {$1}\n"
+    "box 1 0 {100 0} {100 200}\n"
+    "end_cell\n"
+    "begin_cell {$2}\n"
+    "sref {$1} 0 0 1 {0 0}\n"
+    "sref {$1} 0 0 1 {17 -42}\n"
+    "end_cell\n"
+    "end_lib\n"
+    ;
+
+  tl::OutputStringStream os;
+  tl::OutputStream stream (os);
+  db::TextWriter textwriter (stream);
+  textwriter.write (gg);
+  EXPECT_EQ (std::string (os.string ()), std::string (expected))
+}
+
+TEST(119_WithAndWithoutContext)
+{
+  //  PCells with context and without
+
+  db::Manager m;
+  db::Layout g (&m);
+
+  //  Note: this sample requires the BASIC lib
+
+  {
+    std::string fn (tl::testsrc ());
+    fn += "/testdata/oasis/pcell_test.gds";
+    tl::InputStream stream (fn);
+    db::Reader reader (stream);
+    reader.read (g);
+  }
+
+  std::string tmp_file = tl::TestBase::tmp_file (tl::sprintf ("tmp_dbOASISWriter119a.oas"));
+
+  {
+    tl::OutputStream out (tmp_file);
+    db::SaveLayoutOptions options;
+    options.set_format ("OASIS");
+    db::Writer writer (options);
+    writer.write (g, out);
+  }
+
+  {
+    tl::InputStream in (tmp_file);
+    db::Reader reader (in);
+    db::Layout gg;
+    reader.set_warnings_as_errors (true);
+    reader.read (gg);
+
+    std::pair<bool, db::cell_index_type> tc = gg.cell_by_name ("TEXT");
+    tl_assert (tc.first);
+
+    const db::Cell &text_cell = gg.cell (tc.second);
+    EXPECT_EQ (text_cell.is_proxy (), true);
+    EXPECT_EQ (text_cell.get_display_name (), "Basic.TEXT('KLAYOUT RULES')");
+
+    CHECKPOINT ();
+    db::compare_layouts (_this, gg, tl::testsrc () + "/testdata/oasis/dbOASISWriter119_au.gds", db::NoNormalization);
+  }
+
+  tmp_file = tl::TestBase::tmp_file (tl::sprintf ("tmp_dbOASISWriter119b.oas"));
+
+  {
+    tl::OutputStream out (tmp_file);
+    db::SaveLayoutOptions options;
+    options.set_write_context_info (false);
+    options.set_format ("OASIS");
+    db::Writer writer (options);
+    writer.write (g, out);
+  }
+
+  {
+    tl::InputStream in (tmp_file);
+    db::Reader reader (in);
+    db::Layout gg;
+    reader.set_warnings_as_errors (true);
+    reader.read (gg);
+
+    std::pair<bool, db::cell_index_type> tc = gg.cell_by_name ("TEXT");
+    tl_assert (tc.first);
+
+    const db::Cell &text_cell = gg.cell (tc.second);
+    EXPECT_EQ (text_cell.is_proxy (), false);
+    EXPECT_EQ (text_cell.get_display_name (), "TEXT");
+
+    CHECKPOINT ();
+    db::compare_layouts (_this, gg, tl::testsrc () + "/testdata/oasis/dbOASISWriter119_au.gds", db::NoNormalization);
+  }
+
+}
diff --git a/testdata/oasis/dbOASISWriter119_au.gds b/testdata/oasis/dbOASISWriter119_au.gds
new file mode 100644
index 0000000000000000000000000000000000000000..120a3f609c2bf763dc608de6b4ac849be58bd0e1
GIT binary patch
literal 3838
zcma)<eP~r>9LJygvg7r7x9-;5?(VL8(IGbX(q5gpbknUD6DMI}Bg#LrLWKMyR(}W?
z3^A>gj3Ff<6b4GBLK5_X^@sR}Noj<Nl$oH}G&KbU>-7CT-}89F?#wgp{p|dn-~01&
z&NZHiMwgmgBs%U_<C!%6?lW!w{@)~`-hxNx8dDl8nBDvOjK>aqbZKVaXU*H*8(eI1
z1$VIXyv6-X7n^v(7_TsDBE~C<8e@jjG2i#Q+{c*sX=5T!hm3uQ`%T8geiS(#+oy3d
zdKRCP_!LSWX(Q>6`i_XyC%<Nhbn)zXycq6o%d0ybgK)R(<GU5lLk^5jGRN^vj!th(
ze^1e0a+>s#(~#o^V<x;Re}w~L(RRs;wo5Oy#u52{VoYkGqw`~#FaMVqFMUXQ=|jl#
zb7St=rhbvEqxe8b_P6+F#Qze!4)PwPUTIZG_PgYY{FPjB{>RK?HS;K|litJ(^2a=o
z(JzcCpB<9@EMKL5k{ow>B=ae&Qy!W1V#SE$B>iUAD^3tEUtjDzRBn}C7VC<3B<sxW
z3(0(P=adi0@#><Gw5y8BPv9?KyalYkwq1I)?W(H=i;eY>^jo(!B;`{EH9lp~*;(fE
zzmopzuS>5!n6IW4^4C11{*Y16nC2Af*$U#G`=ohDc8!Z1)sIHZH}^?nmGf(vFTU+(
z%WCP}k9lKXNY>Rl5|aIFJ*a+?9B;oEl6GyU<tOl$FJ3q6?KmgBj&ri_3g(4moCltB
zbb6Ng{Mq@LwM=@mmdW3opF(mzX7AN}ko3=S(b<jZ->(1OGt%ohrv8wTtH$)44~Tot
z59M6vy=N4^Z@$>SL~=4Z)tG+t%98h`xChz4zWIt1#IyB|!!o|Zxt!FwT-TES1e~xI
z5pc3vVzyE_WHJn*6J+5d7>C@_=@ptWJ6-lQG9AHA9s++6V>3a>>972PnCSu`C#grd
zwUd25|8`|Gup>*2A?dI2Td^r4e`NFn$(<gU$6x%AeKM^;N9_kQk(F;p`j0e7#@y(S
z<Tx)!djq*+<Qv(M&c+f7>?JQt)NOUpSKhN9B>fh=5|a7}toU0*EUyT60jWRXd+8@H
z$q&hk^XeFRS@Y;fc_CK1Bjcz3lAn_OA=w8$IoQ|q-|9EXxak){(!Tf|=%F5xS4n+H
z%I{sG{7Bk!osbhx$uDWw0pz^w`XCSEYeZx|l+$j~?vPwZla@;_hg_&%iGET}Qoj;&
z=y+=!D)hsv>LGl=j-+1AcOe<K_NMYAc};#hB*&+GrE!w>)Axs@CfBVa=e}W7Yk=#P
zaV_z0(=MwfB7e#`Z<es*IM)=(xRf(q+oq7LyRBb-TPwtt!yx1&^;^0^GQJ&$3jOeE
zpNcQYN$Pi^PmUa)`98k`LT^UUKazUg(?U{jP8q)gLcbe*qJNV8c#tP%K-NdOBkQES
zBmK|ql>gpsl9SY@oPOqg9Pm1b{>=kfKjn-&_qBk~r`+0M&(jb0K56whj?3DEeQ)6l
z_N0vizcw!Xx%k{K^v8X{ILw=IEul|2{c+FJkE0upXL&ZUzJTa`e;w{E-MMAQ?&e8Q
z>Uob3Jh8CvnMDH&o_u&<Asz|0KNF%Uo{3k{hw>kM|4+P8mS6V$EAJYUsrUWMYe2lQ
zURni0{>MsVD)44-5q-^8`~HQ^;0fO!Mc*rTf_yY>^!?wT#r_)h{qx7MuhxM$Gpe_M
zCD>nkeg8MeYmb6>5>LJ%PTwGT!yf519+6$sC<y)LoATRY6sP5y;<g@F9&J06SNn41
z*^yA*9h+50XIyo4;th;-c0$g&JNb*?d98EvCgqslUEm<*=O7rzydA?E3gq#VU;<|~
z&fa#MJKm?*H#>|Ow-#?g$T882{d5gH17f+1f022Er?6kK?~_;?jYmMp8}@*2;Jm=E
z26FNZ$!m{-(5u-iyXr0SQ?*WhCk-o3ZlmH>?o=Mx6Ur-FtvoAMEAPx@)sewmvaSrz
zXVl4gX5E~3&A*<R|MPZ{z}v;ZB7{idM?}eg*B90k{Ohu76ne=L`%4ka&&x(Il&UP~
ot&s{|KMHz+e~n#>7kYgEEc_QMMnblCV>x;f6?NUJA|5yY00EfwVgLXD

literal 0
HcmV?d00001

diff --git a/testdata/oasis/pcell_test.gds b/testdata/oasis/pcell_test.gds
new file mode 100644
index 0000000000000000000000000000000000000000..031c8f8e2ddcd8fcb68ed11a642a448619c1ebc4
GIT binary patch
literal 4898
zcmc(jX>3$g6vxl3lrpVtEoEqjF0|1?+i9nrDO-z_wl1M|8U=zVVuco}wQXpv8i~P#
z7>#Sx5TnMBXf)Bdk!Va@qJAKJK%!_|2*EY3fPk7nqCWrsd*1ccIt9O|FPZtxJNMlG
zIrrS<y;j2F_pgzd&p+*u1mrB4DK%0x@wY_$;S17T9T%rBZIr@5XldIW3s&rY>e!-=
zSL$~@vUa7!LR0rG3Wuwzs@l`tD?8V$Tz^sb`DxrrFk7UsAbd%BRd>hwo^;n`7o@wZ
z5+aejfY>Ws<Cl;`Yr{S5on2k6fAJMzYfuW%T0Jx}JTNpiI<K{|Ice+xX`y{&c<`o8
z!$b30FW>0?TwL84Ur^f|Pb{fRP5hBaE@49=Id7dR`&D^M@5X`aDO}m4cAv?oda(DV
zzAex-T%4$HSZCsj<kp6}E?VBYymxe9gGewRAB;4+Ak5KYfRo3U!yY<5dKi_66fyh0
z{{HnF5u~!RA>ObcrSWG-p=}$yLE923(<|F+*|3={iFl*-nLeS#?XyT*vb1GzbfkB~
zz|bb6r!CVohYb^3;%*LM$zu*z5A>SKG-!{IY7GpH_iY*No7XzF<@!Et39A2fy(T~c
zGMu}>X)EbBb*b(j9vVYd4W@@rVvIZ1cOz`)uIOsJEWK)F`6a8mIxjs}BTZHREUo{)
zQT^0^UwyOY|E#{9<;nH$?;RZNGj;o)>px9Sdp;C~|9%PtvoN1Ie(^~-*DvD7u5p~7
zKNp$xf#dx2DtO#+PCP6Uo$oluw}IOn=hz4c`;UVnv$s0V(HlgH%N*y(1K<J2IsCRr
z$ul4my4P`j*eEh*yW@QSiAd?~;AWAshrj}n@?DPe9qbkFgRhCqJ*BL<Q|+}cs$boH
z?H4}`!oU7k)lG=TN&KR58$Z!Jnx59Yl6{(IDogWDJ)q-g4(hm?*XlT%VduD;UvL~}
z6N$s|ZV+SgJqNBub@qTkk-*0yDcFMtK@>3bo=B2g@FkI^r$wgSCenx;v)V)wzkpwX
zkefctyur^z;)iiqHH*~k2Vt*$5xh&J=1%3@Q);hxAB11|F6~$Lkm{7)uDWx!Yn<4<
z8n@&b&7=5$=2cv#dCuOdc}I`yIHH(Kjw?D}$H{r-xH<1S|9YmLVNGR+?Rh(CB}ogP
zFEdaHe~!zec<98C1u~9cG-S?&Xoua<`sHY36n4VOlrHKOy@hOdfa4%$iwrDMJN0HA
zQQhc5wUhLt-SpG`=4mlW-{f1n8u_fjY=G3Odq)|MsvhZoT<z8m%%B(C%bnz0V?US$
ztf<ba2`t8Hxexa)nP*d{=Giz~nb@cKlk}Sd4NLmZ!K&l9VyFRGf?Co}(y!o6j~q|_
zr<#A>?>a7$ejJM>{d~1*qbA!(w)3(yH?Uj!u<O~6w0#WWz&Yk+i2RHX=9~ANKa#qk
z8$HrLtDoO45i6XF8<+H-ft^QYA5$HY7uTJo52q8?mnH2vhfK2}<41l|oxIH+Y0rNU
zxgk%IR{?j6OWMy~t#L`_!SzVa{7mahGGDV^@zbnFa-Z5s)|+<rD{<$6WIr>X_{n+a
zReC<YU?=Hc{;o&rRN!>6r2pLe`K_eA@(pb#*}vvZkM!fZx8xkv;*=t}?itq*KjY6C
zHznqicGlOB{%GgilZ;C{<0Te)q@G#dkm5ezl{^Puu#@!XDQwC1MUU~@CHxk+^&sij
zQtgp`=N0kWCHz}3Zt9a9SL^p4nJ?{@%$xl!slU8g_1ku;ouohQ)N6m%<w+3rXa~6;
zX=mK!x4MKs?WQ0040X77NaM$LT&6$RaSy)GpEPlxYvMxB#^<?2J+52EVcv{u2!GnC
z$Gt`!OWV%zne)leo?GNUdJ<&mlRzdv2ezAYa3OTe2le{`W4O{|;0fGg{sSK>*&cXV
z+e!b|_#DJ1NA12ONj>^ovPh~c<D`ve+B2Nb`g{uVX%8Kq&5RpH4wlSudR#T9$F1L#
zdROrIlwGZU*;t2xyKoNOqIx+!%G@W_p8KTwMesJo_>pbM|9P<6(&`vy%72XU^7g7<
z-d^O1x3#l&YQ0E~BY(F?)|cmh;B^q|z}$oMD=hWMdKa8fy@C@~f66?zn&)z*`pt|Y
z|8|^zVBjO1dzGpi#aj*I%-*4P(*GKs%S%17-m^xu-Xz<tA4%OP-U?Z-B8``+E@mD|
z9#OyI`?Md)__3EgGG6RkjYqP*EY~CBmGT*mc&=Wic;>yNBB_2ASewkdJj)|>t8P<W
zlI@jiEp0!;O!|YY@BEYMH~*yS#IIG>k83?ie+X}v*dxA2LELkn)Q@Ywx*ki^1N)>7
z^UZxyS88<)GsQRcOx&z~4VV|!h2*#zcX(ty8~12ENwz1CdSt(*FIC6Y%M`DL<4t|5
zekpfe7P|97GS1?DOY3KtNzcsBlB?8j$yJ)qd51i5K9=s%`5>v!cBSn%rM_AJZSJ_1
zeXR8%eLssV`_3iqIX|>>U$lLx@jF&1J6Efn^q+%s81I3Gyq}4CkoD_Wq4~J+%y`f6
zhR$<2-GeaMc#U%ZIu957pcg3#wUvXsBC*gi^Mk*6Vjn)}jTk+>|Ev6izDJfh&Nqmd
PuTjtR-zPhYU{L-5b|A6l

literal 0
HcmV?d00001