From 6cefbd13f1dac2293aaa1537a6ee2ad23c11a273 Mon Sep 17 00:00:00 2001
From: Tim Edwards <tim@opencircuitdesign.com>
Date: Thu, 22 Dec 2022 14:53:24 -0500
Subject: [PATCH] Expanded the method for "flatten in place" to include the
 more natural flattening from a selection.  That is, instead of specifying
 "flatten -doinplace <cell>", you can select some number of instances and just
 do "flatten -doinplace".

---
 commands/CmdFI.c       | 160 ++++++++--------------
 database/DBcellcopy.c  | 293 ++++++++++++++++++++++++++++++++++++++---
 database/database.h.in |   3 +
 3 files changed, 333 insertions(+), 123 deletions(-)

diff --git a/commands/CmdFI.c b/commands/CmdFI.c
index 127ff706..fb624e71 100644
--- a/commands/CmdFI.c
+++ b/commands/CmdFI.c
@@ -1958,7 +1958,7 @@ CmdFlatten(w, cmd)
     MagWindow *w;
     TxCommand *cmd;
 {
-     int		rval, xMask;
+     int		i, xMask, optargs;
      bool		dolabels, dobox, toplabels, invert, doports, doinplace;
      char		*destname;
      CellDef		*newdef;
@@ -1966,36 +1966,32 @@ CmdFlatten(w, cmd)
      SearchContext	scx;
      CellUse		*flatDestUse;
 
-    destname = cmd->tx_argv[cmd->tx_argc - 1];
+    destname = NULL;
     xMask = CU_DESCEND_ALL;
     dolabels = TRUE;
     toplabels = FALSE;
     dobox = FALSE;
     doports = TRUE;
     doinplace = FALSE;
+    optargs = cmd->tx_argc - 1;
 
-    rval = 0;
-    if (cmd->tx_argc > 2)
+    if (optargs > 0)
     {
-	int i;
-	for (i = 1; i < (cmd->tx_argc - 1); i++)
+	for (i = 1; i < (optargs + 1); i++)
 	{
-	    if (!strncmp(cmd->tx_argv[i], "-no", 3))
+	    if ((cmd->tx_argv[i][0] == '-') && (strlen(cmd->tx_argv[i]) > 3))
 	    {
-		invert = TRUE;
-	    }
-	    else if (!strncmp(cmd->tx_argv[i], "-do", 3))
-	    {
-		invert = FALSE;
-	    }
-	    else
-	    {
-	        rval = -1;
-		break;
-	    }
+		if (!strncmp(cmd->tx_argv[i] + 1, "no", 2))
+		    invert = TRUE;
+		else if (!strncmp(cmd->tx_argv[i] + 1, "do", 2))
+		    invert = FALSE;
+		else
+		{
+		    TxError("Bad flatten option \"%s\";  must start with \"-no\" or \"-do\"\n",
+				cmd->tx_argv[i]);
+		    return;
+		}
 
-	    if (strlen(cmd->tx_argv[i]) > 3)
-	    {
 		switch(cmd->tx_argv[i][3])
 		{
 		    case 'b':
@@ -2029,98 +2025,53 @@ CmdFlatten(w, cmd)
 			break;
 		}
 	    }
+	    else
+		destname = cmd->tx_argv[i];
 	}
     }
-    else if (cmd->tx_argc != 2)
-	rval = -1;
 
-    if (rval != 0)
+    /* Flatten-in-place */
+    if (doinplace)
     {
-     	TxError("usage: flatten [-<option>...] destcell\n");
+	if (destname != NULL)	/* instance name was given in "destname" */
+	{
+	    HashEntry *he;
+	    CellUse *use;
+	
+	    if (EditCellUse == NULL)
+	    {
+		TxError("The current cell is not editable.\n");
+		return;
+	    }
+	    he = HashLookOnly(&EditCellUse->cu_def->cd_idHash, destname);
+	    if (he == NULL)
+	    {
+		TxError("No cell use %s found in edit cell.\n", destname);
+		return;
+	    }
+	    use = (CellUse *)HashGetValue(he);
+	    UndoDisable();
+	    DBFlattenInPlace(use, EditCellUse, xMask, dolabels, toplabels);
+	    UndoEnable();
+	}
+	else
+	{
+	    /* Instances to flatten are taken from SelectDef */
+	    UndoDisable();
+	    scx.scx_use = SelectUse;
+	    scx.scx_area = SelectUse->cu_bbox;
+	    scx.scx_trans = SelectUse->cu_transform;
+
+	    DBCellFlattenAllCells(&scx, EditCellUse, xMask, dolabels, toplabels);
+	    UndoEnable();
+	    SelectClear();
+	}
 	return;
     }
 
-    /* Flatten-in-place:  destname is an instance, not a cell def */
-    if (doinplace)
+    if (destname == NULL)
     {
-	HashEntry *he;
-	Label *lab;
-
-	if (EditCellUse == NULL)
-	{
-	    TxError("The cell def is not editable.\n");
-	    return;
-	}
-
-	he = HashLookOnly(&EditCellUse->cu_def->cd_idHash, destname);
-	if (he == NULL)
-	{
-	    TxError("No cell use %s found in edit cell.\n", destname);
-	    return;
-	}
-	scx.scx_use = (CellUse *)HashGetValue(he);
-	scx.scx_trans = scx.scx_use->cu_transform;
-	scx.scx_area = scx.scx_use->cu_def->cd_bbox;
-
-	/* Mark labels in the subcell top level for later handling */
-	for (lab = scx.scx_use->cu_def->cd_labels; lab; lab = lab->lab_next)
-	    lab->lab_flags |= LABEL_GENERATE;
-
-	UndoDisable();
-
-	DBCellCopyAllPaint(&scx, &DBAllButSpaceAndDRCBits, xMask, EditCellUse);
-	if (dolabels)
-	    FlatCopyAllLabels(&scx, &DBAllTypeBits, xMask, EditCellUse);
-	else if (toplabels)
-	{
-	    int savemask = scx.scx_use->cu_expandMask;
-	    scx.scx_use->cu_expandMask = CU_DESCEND_SPECIAL;
-	    DBCellCopyAllLabels(&scx, &DBAllTypeBits, CU_DESCEND_SPECIAL, EditCellUse);
-	    scx.scx_use->cu_expandMask = savemask;
-	}
-
-	if (xMask != CU_DESCEND_ALL)
-	    DBCellCopyAllCells(&scx, xMask, EditCellUse, (Rect *)NULL);
-
-	/* Marked labels coming from the subcell top level must not be	*/ 
-	/* ports, and text should be prefixed with the subcell name.	*/
-
-	for (lab = EditCellUse->cu_def->cd_labels; lab; lab = lab->lab_next)
-	{
-	    Label *newlab;
-	    char *newtext;
-
-	    if (lab->lab_flags & LABEL_GENERATE)
-	    {
-		newtext = mallocMagic(strlen(lab->lab_text)
-			+ strlen(scx.scx_use->cu_id) + 2);
-
-		sprintf(newtext, "%s/%s", scx.scx_use->cu_id, lab->lab_text);
-
-		DBPutFontLabel(EditCellUse->cu_def,
-			&lab->lab_rect, lab->lab_font, lab->lab_size,
-			lab->lab_rotate, &lab->lab_offset, lab->lab_just,
-			newtext, lab->lab_type, 0, 0);
-		DBEraseLabelsByContent(EditCellUse->cu_def, &lab->lab_rect,
-			-1, lab->lab_text);
-
-		freeMagic(newtext);
-	    }
-	}
-	
-	/* Unmark labels in the subcell top level */
-	for (lab = scx.scx_use->cu_def->cd_labels; lab; lab = lab->lab_next)
-	    lab->lab_flags &= ~LABEL_GENERATE;
-
-	/* Copy and transform mask hints from child to parent */
-	DBCellCopyMaskHints(scx.scx_use, EditCellUse->cu_def);
-
-	/* Remove the use */
-	DBDeleteCell(scx.scx_use);
-
-	UndoEnable();
-	DBWAreaChanged(EditCellUse->cu_def, &scx.scx_use->cu_def->cd_bbox,
-			DBW_ALLWINDOWS, &DBAllButSpaceAndDRCBits);
+     	TxError("usage: flatten [-<option>...] destcell\n");
 	return;
     }
 
@@ -2171,6 +2122,7 @@ CmdFlatten(w, cmd)
     UndoDisable();
 
     DBCellCopyAllPaint(&scx, &DBAllButSpaceAndDRCBits, xMask, flatDestUse);
+    DBFlatCopyMaskHints(&scx, xMask, flatDestUse);
     if (dolabels)
 	FlatCopyAllLabels(&scx, &DBAllTypeBits, xMask, flatDestUse);
     else if (toplabels)
diff --git a/database/DBcellcopy.c b/database/DBcellcopy.c
index a9f591c7..9de59762 100644
--- a/database/DBcellcopy.c
+++ b/database/DBcellcopy.c
@@ -352,20 +352,12 @@ DBCellCheckCopyAllPaint(scx, mask, xMask, targetUse, func)
     DBTreeSrTiles(scx, &locMask, xMask, dbCopyAllPaint, (ClientData) &arg);
 }
 
-/* Client data structure used by DBCellGenerateSubstrate() */
-
-struct dbCopySubData {
-    Plane *csd_plane;
-    TileType csd_subtype;
-    int csd_pNum;
-    bool csd_modified;
-};
-
 /* Data structure used by dbCopyMaskHintsFunc */
 
 struct propUseDefStruct {
-   CellUse *child;
-   CellDef *parent;
+   CellDef *puds_source;
+   CellDef *puds_dest;
+   Transform *puds_trans;	/* Transform from source use to dest */
 };
 
 /*
@@ -393,25 +385,29 @@ dbCopyMaskHintsFunc(key, value, puds)
     ClientData value;
     struct propUseDefStruct *puds;
 {
-    CellUse *use = puds->child;
-    CellDef *def = puds->parent;
+    CellDef *dest = puds->puds_dest;
+    Transform *trans = puds->puds_trans;
     char *propstr = (char *)value;
-    char *newvalue, *vptr;
+    char *parentprop, *newvalue, *vptr;
     Rect r, rnew;
+    bool propfound;
 
     if (!strncmp(key, "MASKHINTS_", 10))
     {
 	char *vptr, *lastval;
 	int lastlen;
 
-	newvalue = (char *)NULL;
+	/* Append to existing mask hint (if any) */
+	parentprop = (char *)DBPropGet(dest, key, &propfound);
+	newvalue = (propfound) ? StrDup((char **)NULL, parentprop) : (char *)NULL;
+
 	vptr = propstr;
 	while (*vptr != '\0')
 	{
 	    if (sscanf(vptr, "%d %d %d %d", &r.r_xbot, &r.r_ybot,
 			&r.r_xtop, &r.r_ytop) == 4)
 	    {
-		GeoTransRect(&use->cu_transform, &r, &rnew);
+		GeoTransRect(trans, &r, &rnew);
 
 		lastval = newvalue;
 		lastlen = (lastval) ? strlen(lastval) : 0;
@@ -438,7 +434,7 @@ dbCopyMaskHintsFunc(key, value, puds)
 	    else break;
 	}
 	if (newvalue)
-	    DBPropPut(def, key, newvalue);
+	    DBPropPut(dest, key, newvalue);
     }
 
     return 0;
@@ -468,11 +464,270 @@ DBCellCopyMaskHints(child, parent)
 {
     struct propUseDefStruct puds;
 
-    puds.child = child;
-    puds.parent = parent;
+    puds.puds_source = child->cu_def;
+    puds.puds_dest = parent;
+    puds.puds_trans = &child->cu_transform;
     DBPropEnum(child->cu_def, dbCopyMaskHintsFunc, (ClientData)&puds);
 }
 
+/*
+ *-----------------------------------------------------------------------------
+ *
+ * dbFlatCopyMaskHintsFunc ---
+ *
+ * Callback function used by DBFlatCopyMaskHints() to copy mask hint
+ * properties from a child cell into a flattened cell def.  This is
+ * simply a variant of DBCellCopyMaskHints() above, with arguments
+ * appropriate to being called from DBTreeSrCells(), and applying
+ * the transform from the search context.
+ *
+ * Results:
+ *	0 to keep the cell search going.
+ * 
+ * Side effects:
+ *	Generates properties in the target def.
+ *
+ *-----------------------------------------------------------------------------
+ */
+int
+dbFlatCopyMaskHintsFunc(scx, def)
+    SearchContext *scx;
+    CellDef *def;
+{
+    struct propUseDefStruct puds;
+    CellUse *use = scx->scx_use;
+
+    puds.puds_source = scx->scx_use->cu_def;
+    puds.puds_dest = def;
+    puds.puds_trans = &scx->scx_trans;
+
+    DBPropEnum(use->cu_def, dbCopyMaskHintsFunc, (ClientData)&puds);
+
+    return 0;
+}
+
+/*
+ *-----------------------------------------------------------------------------
+ *
+ * DBFlatCopyMaskHints --
+ *
+ * This function is used by the "flatten" command option to copy information
+ * in mask-hint properties from flattened children to a flattened cell def.
+ *
+ * Results:
+ *	None.
+ *
+ * Side effects:
+ *	Properties copied from child to parent cell and modified.
+ *
+ *-----------------------------------------------------------------------------
+ */
+void
+DBFlatCopyMaskHints(scx, xMask, targetUse)
+    SearchContext *scx;		/* Describes root cell to search, area to
+				 * copy, transform from root cell to coords
+				 * of targetUse.
+				 */
+    int xMask;			/* Expansion state mask to be used in search */
+    CellUse *targetUse;		/* Cell into which properties will be added */
+{
+    DBTreeSrCells(scx, xMask, dbFlatCopyMaskHintsFunc, (ClientData)targetUse->cu_def);
+}
+
+/*
+ *-----------------------------------------------------------------------------
+ *
+ * DBFlattenInPlace --
+ *
+ * This function is used by the "flatten" command "-doinplace" option to
+ * flatten a cell instance into its parent cell.
+ *
+ * Results:
+ *	None.
+ *
+ * Side effects:
+ *	Indicated cell use is flattened into the edit cell def.
+ *
+ *-----------------------------------------------------------------------------
+ */
+
+void
+DBFlattenInPlace(use, dest, xMask, dolabels, toplabels)
+    CellUse *use;		/* Cell use to flatten */
+    CellUse *dest;		/* Cell use to flatten into */
+    int xMask;			/* Search mask for flattening */
+    bool dolabels;		/* Option to flatten labels */
+    bool toplabels;		/* Option to selectively flatten top-level labels */
+{
+    Label *lab;
+    SearchContext scx;
+
+    if (dest == NULL)
+    {
+	TxError("The target cell does not exist or is not editable.\n");
+	return;
+    }
+
+    scx.scx_use = use;
+    scx.scx_trans = use->cu_transform;
+    scx.scx_area = use->cu_def->cd_bbox;
+
+    /* Mark labels in the subcell top level for later handling */
+    for (lab = scx.scx_use->cu_def->cd_labels; lab; lab = lab->lab_next)
+	lab->lab_flags |= LABEL_GENERATE;
+
+    DBCellCopyAllPaint(&scx, &DBAllButSpaceAndDRCBits, xMask, dest);
+    if (dolabels)
+	FlatCopyAllLabels(&scx, &DBAllTypeBits, xMask, dest);
+    else if (toplabels)
+    {
+	int savemask = scx.scx_use->cu_expandMask;
+	scx.scx_use->cu_expandMask = CU_DESCEND_SPECIAL;
+	DBCellCopyAllLabels(&scx, &DBAllTypeBits, CU_DESCEND_SPECIAL, dest);
+	scx.scx_use->cu_expandMask = savemask;
+    }
+
+    if (xMask != CU_DESCEND_ALL)
+	DBCellCopyAllCells(&scx, xMask, dest, (Rect *)NULL);
+
+    /* Marked labels coming from the subcell top level must not be	*/ 
+    /* ports, and text should be prefixed with the subcell name.	*/
+
+    for (lab = dest->cu_def->cd_labels; lab; lab = lab->lab_next)
+    {
+	Label *newlab;
+	char *newtext;
+
+	if (lab->lab_flags & LABEL_GENERATE)
+	{
+	    newtext = mallocMagic(strlen(lab->lab_text)
+			+ strlen(scx.scx_use->cu_id) + 2);
+
+	    sprintf(newtext, "%s/%s", scx.scx_use->cu_id, lab->lab_text);
+
+	    DBPutFontLabel(dest->cu_def,
+			&lab->lab_rect, lab->lab_font, lab->lab_size,
+			lab->lab_rotate, &lab->lab_offset, lab->lab_just,
+			newtext, lab->lab_type, 0, 0);
+	    DBEraseLabelsByContent(dest->cu_def, &lab->lab_rect,
+			-1, lab->lab_text);
+
+	    freeMagic(newtext);
+	}
+    }
+	
+    /* Unmark labels in the subcell top level */
+    for (lab = scx.scx_use->cu_def->cd_labels; lab; lab = lab->lab_next)
+	lab->lab_flags &= ~LABEL_GENERATE;
+
+    /* Copy and transform mask hints from child to parent */
+    DBCellCopyMaskHints(scx.scx_use, dest->cu_def);
+
+    /* Remove the use from the parent def */
+    DBDeleteCell(scx.scx_use);
+
+    DBWAreaChanged(dest->cu_def, &scx.scx_use->cu_def->cd_bbox,
+			DBW_ALLWINDOWS, &DBAllButSpaceAndDRCBits);
+}
+
+/* Client data structure used by DBCellFlattenAllCells() */
+
+struct dbFlattenAllData {
+    CellUse *fad_dest;		/* Cell use to flatten into */
+    int fad_xmask;		/* Search mask for flattening */
+    bool fad_dolabels;		/* Option to flatten labels */
+    bool fad_toplabels;		/* Option to selectively flatten top-level labels */
+};
+
+/*
+ *-----------------------------------------------------------------------------
+ *
+ * dbCellFlattenCellsFunc --
+ *
+ * Do the actual work of flattening cells for DBCellFlattenAllCells().
+ *
+ * Results:
+ *	Always return 2.
+ *
+ * Side effects:
+ *	Updates the paint planes of EditRootDef.
+ *
+ *-----------------------------------------------------------------------------
+ */
+
+int
+dbCellFlattenCellsFunc(scx, clientData)
+    SearchContext *scx;	/* Pointer to search context containing
+			 * ptr to cell use to be copied,
+			 * and transform to the target def.
+			 */
+    ClientData clientData;	/* Data passed to client function */
+{
+    CellUse *use, *dest;
+    int xMask;
+    bool dolabels;
+    bool toplabels;
+    struct dbFlattenAllData *fad = (struct dbFlattenAllData *)clientData;
+
+    dest = fad->fad_dest;
+    xMask = fad->fad_xmask;
+    dolabels = fad->fad_dolabels;
+    toplabels = fad->fad_toplabels;
+
+    use = scx->scx_use;
+    DBFlattenInPlace(use, dest, xMask, dolabels, toplabels);
+    return 2;
+}
+
+/*
+ *-----------------------------------------------------------------------------
+ *
+ * DBCellFlattenAllCells --
+ *
+ * Flatten subcells from the tree rooted at scx->scx_use into the edit root
+ * CellDef, transforming according to the transform in scx.
+ *
+ * Results:
+ *	None.
+ *
+ * Side effects:
+ *	Updates the paint planes in EditRootDef.
+ *
+ *-----------------------------------------------------------------------------
+ */
+
+void
+DBCellFlattenAllCells(scx, dest, xMask, dolabels, toplabels)
+    SearchContext *scx;		/* Describes root cell to search and transform
+				 * from root cell to coords of targetUse.
+				 */
+    CellUse *dest;		/* CellUse to flatten into (usually EditCellUse) */
+    int xMask;			/* Expansion state mask to be passed to
+				 * the flattening routine that determines
+				 * whether to do a shallow or deep flattening.
+				 */
+    bool dolabels;		/* Option to flatten labels */
+    bool toplabels;		/* Option to selectively flatten top-level labels */
+{
+    int dbCellFlattenCellsFunc();
+    struct dbFlattenAllData fad;
+
+    fad.fad_dest = dest;
+    fad.fad_xmask = xMask;
+    fad.fad_dolabels = dolabels;
+    fad.fad_toplabels = toplabels;
+    DBTreeSrCells(scx, CU_DESCEND_ALL, dbCellFlattenCellsFunc, (ClientData)&fad);
+}
+
+/* Client data structure used by DBCellGenerateSubstrate() */
+
+struct dbCopySubData {
+    Plane *csd_plane;
+    TileType csd_subtype;
+    int csd_pNum;
+    bool csd_modified;
+};
+
 /*
  *-----------------------------------------------------------------------------
  *
diff --git a/database/database.h.in b/database/database.h.in
index 1e6ca941..ef8ff802 100644
--- a/database/database.h.in
+++ b/database/database.h.in
@@ -891,6 +891,7 @@ extern void DBCellCopyAllLabels();
 extern void DBCellCopyGlobLabels();
 extern void DBCellCopyCells();
 extern void DBCellCopyAllCells();
+extern void DBFlatCopyMaskHints();
 extern Plane *DBCellGenerateSubstrate();
 
     /* Contact image handling */
@@ -917,6 +918,8 @@ extern void DBEnumerateTypes();
 extern Plane *DBNewPlane();
 extern bool DBDescendSubcell();
 extern void DBCellCopyMaskHints();
+extern void DBFlattenInPlace();
+extern void DBCellFlattenAllCells();
 
 extern PaintResultType (*DBNewPaintTable())[TT_MAXTYPES][TT_MAXTYPES];
 typedef int (*IntProc)();