4 * PCB, interactive printed circuit board design
5 * Copyright (C) 1994,1995,1996,1997,1998,2005,2006 Thomas Nau
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * Contact addresses for paper mail and Email:
22 * Thomas Nau, Schlehenweg 15, 88471 Baustetten, Germany
23 * Thomas.Nau@rz.uni-ulm.de
27 /* file save, load, merge ... routines
28 * getpid() needs a cast to (int) to get rid of compiler warnings
29 * on several architectures
36 #ifdef HAVE_SYS_PARAM_H
37 #include <sys/param.h>
48 #ifdef HAVE_SYS_SOCKET_H
49 #include <sys/socket.h>
54 #ifdef HAVE_NETINET_IN_H
55 #include <netinet/in.h>
80 #include "crosshair.h"
82 #include "edif_parse.h"
89 #include "pcb-printf.h"
96 #ifdef HAVE_LIBDMALLOC
100 #if !defined(HAS_ATEXIT) && !defined(HAS_ON_EXIT)
101 /* ---------------------------------------------------------------------------
102 * some local identifiers for OS without an atexit() or on_exit()
105 static char TMPFilename
[80];
108 /* ---------------------------------------------------------------------------
109 * some local prototypes
111 static void PrintQuotedString (FILE *, char *);
112 static void WritePCBInfoHeader (FILE *);
113 static void WritePCBDataHeader (FILE *);
114 static void WritePCBFontData (FILE *);
115 static void WriteViaData (FILE *, DataType
*);
116 static void WritePCBRatData (FILE *);
117 static void WriteElementData (FILE *, DataType
*);
118 static void WriteLayerData (FILE *, Cardinal
, LayerType
*);
119 static int WritePCB (FILE *);
120 static int WritePCBFile (char *);
121 static int WritePipe (char *, bool);
122 static int ParseLibraryTree (void);
123 static int LoadNewlibFootprintsFromDir(char *path
, char *toppath
);
124 static char *pcb_basename (char *p
);
126 /* ---------------------------------------------------------------------------
127 * Flag helper functions
130 #define F2S(OBJ, TYPE) flags_to_string ((OBJ)->Flags, TYPE)
132 /* --------------------------------------------------------------------------- */
134 /* The idea here is to avoid gratuitously breaking backwards
135 compatibility due to a new but rarely used feature. The first such
136 case, for example, was the polygon Hole - if your design included
137 polygon holes, you needed a newer PCB to read it, but if your
138 design didn't include holes, PCB would produce a file that older
139 PCBs could read, if only it had the correct version number in it.
141 If, however, you have to add or change a feature that really does
142 require a new PCB version all the time, it's time to remove all the
143 tests below and just always output the new version.
145 Note: Best practices here is to add support for a feature *first*
146 (and bump PCB_FILE_VERSION in file.h), and note the version that
147 added that support below, and *later* update the file format to
148 need that version (which may then be older than PCB_FILE_VERSION).
149 Hopefully, that allows for one release between adding support and
150 needing it, which should minimize breakage. Of course, that's not
151 *always* possible, practical, or desirable.
155 /* Hole[] in Polygon. */
156 #define PCB_FILE_VERSION_HOLES 20100606
157 /* First version ever saved. */
158 #define PCB_FILE_VERSION_BASELINE 20091103
161 PCBFileVersionNeeded (void)
163 ALLPOLYGON_LOOP (PCB
->Data
);
165 if (polygon
->HoleIndexN
> 0)
166 return PCB_FILE_VERSION_HOLES
;
170 return PCB_FILE_VERSION_BASELINE
;
173 /* --------------------------------------------------------------------------- */
176 string_cmp (const char *a
, const char *b
)
180 if (isdigit ((int) *a
) && isdigit ((int) *b
))
186 while (isdigit ((int) *a
) && *(a
+1))
188 while (isdigit ((int) *b
) && *(b
+1))
191 else if (tolower ((int) *a
) != tolower ((int) *b
))
192 return tolower ((int) *a
) - tolower ((int) *b
);
203 static int netlist_sort_offset
= 0;
206 netlist_sort (const void *va
, const void *vb
)
208 LibraryMenuType
*am
= (LibraryMenuType
*) va
;
209 LibraryMenuType
*bm
= (LibraryMenuType
*) vb
;
216 return string_cmp (a
, b
);
220 netnode_sort (const void *va
, const void *vb
)
222 LibraryEntryType
*am
= (LibraryEntryType
*) va
;
223 LibraryEntryType
*bm
= (LibraryEntryType
*) vb
;
224 char *a
= am
->ListEntry
;
225 char *b
= bm
->ListEntry
;
226 return string_cmp (a
, b
);
230 sort_library (LibraryType
*lib
)
233 qsort (lib
->Menu
, lib
->MenuN
, sizeof (lib
->Menu
[0]), netlist_sort
);
234 for (i
= 0; i
< lib
->MenuN
; i
++)
235 qsort (lib
->Menu
[i
].Entry
,
236 lib
->Menu
[i
].EntryN
, sizeof (lib
->Menu
[i
].Entry
[0]), netnode_sort
);
242 netlist_sort_offset
= 2;
243 sort_library (&(PCB
->NetlistLib
));
244 netlist_sort_offset
= 0;
247 /* ---------------------------------------------------------------------------
248 * opens a file and check if it exists
251 CheckAndOpenFile (char *Filename
, bool Confirm
, bool AllButton
,
252 bool * WasAllButton
, bool * WasCancelButton
)
256 char message
[MAXPATHLEN
+ 80];
259 if (Filename
&& *Filename
)
261 if (!stat (Filename
, &buffer
) && Confirm
)
263 sprintf (message
, _("File '%s' exists, use anyway?"), Filename
);
265 *WasAllButton
= false;
267 *WasCancelButton
= false;
270 gui
->confirm_dialog (message
, "Cancel", "Ok",
271 AllButton
? "Sequence OK" : 0);
274 gui
->confirm_dialog (message
, "Cancel", "Ok", "Sequence OK");
280 *WasAllButton
= true;
284 *WasCancelButton
= true;
287 if ((fp
= fopen (Filename
, "w")) == NULL
)
288 OpenErrorMessage (Filename
);
293 /* ---------------------------------------------------------------------------
294 * opens a file for saving connection data
297 OpenConnectionDataFile (void)
301 static char * default_file
= NULL
;
302 bool result
; /* not used */
304 /* CheckAndOpenFile deals with the case where fname already exists */
305 fname
= gui
->fileselect (_("Save Connection Data As ..."),
306 _("Choose a file to save all connection data to."),
307 default_file
, ".net", "connection_data",
312 if (default_file
!= NULL
)
319 default_file
= strdup (fname
);
321 fp
= CheckAndOpenFile (fname
, true, false, &result
, NULL
);
327 /* ---------------------------------------------------------------------------
328 * save elements in the current buffer
331 SaveBufferElements (char *Filename
)
337 result
= WritePipe (Filename
, false);
343 /* ---------------------------------------------------------------------------
351 if (gui
->notify_save_pcb
== NULL
)
352 return WritePipe (file
, true);
354 gui
->notify_save_pcb (file
, false);
355 retcode
= WritePipe (file
, true);
356 gui
->notify_save_pcb (file
, true);
361 /* ---------------------------------------------------------------------------
362 * set the route style to the first one, if the current one doesn't
363 * happen to match any. This way, "revert" won't change the route
367 set_some_route_style ()
369 if (hid_get_flag ("style"))
371 SetLineSize (PCB
->RouteStyle
[0].Thick
);
372 SetViaSize (PCB
->RouteStyle
[0].Diameter
, true);
373 SetViaDrillingHole (PCB
->RouteStyle
[0].Hole
, true);
374 SetKeepawayWidth (PCB
->RouteStyle
[0].Keepaway
);
377 /* ---------------------------------------------------------------------------
379 * parse the file with enabled 'PCB mode' (see parser)
380 * if successful, update some other stuff
382 * If revert is true, we pass "revert" as a parameter
383 * to the HID's PCBChanged action.
386 real_load_pcb (char *Filename
, bool revert
)
388 const char *unit_suffix
, *grid_size
;
390 PCBType
*newPCB
= CreateNewPCB (false);
399 new_filename
= strdup (Filename
);
404 /* mark the default font invalid to know if the file has one */
405 newPCB
->Font
.Valid
= false;
407 /* new data isn't added to the undo list */
408 if (!ParsePCB (PCB
, new_filename
))
412 CreateNewPCBPost (PCB
, 0);
413 ResetStackAndVisibility ();
415 /* update cursor location */
416 Crosshair
.X
= CLAMP (PCB
->CursorX
, 0, PCB
->MaxWidth
);
417 Crosshair
.Y
= CLAMP (PCB
->CursorY
, 0, PCB
->MaxHeight
);
419 /* update cursor confinement and output area (scrollbars) */
420 ChangePCBSize (PCB
->MaxWidth
, PCB
->MaxHeight
);
422 /* enable default font if necessary */
423 if (!PCB
->Font
.Valid
)
426 ("File '%s' has no font information, using default font\n"),
428 PCB
->Font
.Valid
= true;
431 /* clear 'changed flag' */
432 SetChangedFlag (false);
433 PCB
->Filename
= new_filename
;
434 /* just in case a bad file saved file is loaded */
436 /* Use attribute PCB::grid::unit as unit, if we can */
437 unit_suffix
= AttributeGet (PCB
, "PCB::grid::unit");
438 if (unit_suffix
&& *unit_suffix
)
440 const Unit
*new_unit
= get_unit_struct (unit_suffix
);
442 Settings
.grid_unit
= new_unit
;
444 AttributePut (PCB
, "PCB::grid::unit", Settings
.grid_unit
->suffix
);
445 /* Use attribute PCB::grid::size as size, if we can */
446 grid_size
= AttributeGet (PCB
, "PCB::grid::size");
449 PCB
->Grid
= GetValue (grid_size
, NULL
, NULL
);
454 set_some_route_style ();
457 hid_actionl ("PCBChanged", "revert", NULL
);
459 hid_action ("PCBChanged");
463 elapsed
= ((double) (end
- start
)) / CLOCKS_PER_SEC
;
464 gui
->log ("Loading file %s took %f seconds of CPU time\n",
465 new_filename
, elapsed
);
471 hid_action ("PCBChanged");
473 /* release unused memory */
478 /* ---------------------------------------------------------------------------
484 return real_load_pcb (file
, false);
487 /* ---------------------------------------------------------------------------
493 return real_load_pcb (PCB
->Filename
, true);
496 /* ---------------------------------------------------------------------------
497 * writes the quoted string created by another subroutine
500 PrintQuotedString (FILE * FP
, char *S
)
502 static DynamicStringType ds
;
504 CreateQuotedString (&ds
, S
);
508 /* ---------------------------------------------------------------------------
509 * writes out an attribute list
512 WriteAttributeList (FILE * FP
, AttributeListType
*list
, char *prefix
)
516 for (i
= 0; i
< list
->Number
; i
++)
517 fprintf (FP
, "%sAttribute(\"%s\" \"%s\")\n",
518 prefix
, list
->List
[i
].name
, list
->List
[i
].value
);
521 /* ---------------------------------------------------------------------------
522 * writes layout header information
525 WritePCBInfoHeader (FILE * FP
)
527 /* write some useful comments */
528 fprintf (FP
, "# release: %s " VERSION
"\n", Progname
);
530 /* avoid writing things like user name or date, as these cause merge
531 * conflicts in collaborative environments using version control systems
535 /* ---------------------------------------------------------------------------
537 * the name of the PCB, cursor location, zoom and grid
538 * layergroups and some flags
541 WritePCBDataHeader (FILE * FP
)
546 * ************************** README *******************
547 * ************************** README *******************
549 * If the file format is modified in any way, update
550 * PCB_FILE_VERSION in file.h as well as PCBFileVersionNeeded()
551 * at the top of this file.
553 * ************************** README *******************
554 * ************************** README *******************
557 fprintf (FP
, "\n# To read pcb files, the pcb version (or the git source date) must be >= the file version\n");
558 fprintf (FP
, "FileVersion[%i]\n", PCBFileVersionNeeded ());
560 fputs ("\nPCB[", FP
);
561 PrintQuotedString (FP
, (char *)EMPTY (PCB
->Name
));
562 pcb_fprintf (FP
, " %mr %mr]\n\n", PCB
->MaxWidth
, PCB
->MaxHeight
);
563 pcb_fprintf (FP
, "Grid[%s %mr %mr %d]\n", c_dtostr (COORD_TO_MIL (PCB
->Grid
) * 100), PCB
->GridOffsetX
, PCB
->GridOffsetY
, Settings
.DrawGrid
);
564 /* PolyArea should be output in square cmils, no suffix */
565 fprintf (FP
, "PolyArea[%s]\n", c_dtostr (COORD_TO_MIL (COORD_TO_MIL (PCB
->IsleArea
) * 100) * 100));
566 pcb_fprintf (FP
, "Thermal[%s]\n", c_dtostr (PCB
->ThermScale
));
567 pcb_fprintf (FP
, "DRC[%mr %mr %mr %mr %mr %mr]\n", PCB
->Bloat
, PCB
->Shrink
,
568 PCB
->minWid
, PCB
->minSlk
, PCB
->minDrill
, PCB
->minRing
);
569 fprintf (FP
, "Flags(%s)\n", pcbflags_to_string(PCB
->Flags
));
570 fprintf (FP
, "Groups(\"%s\")\n", LayerGroupsToString (&PCB
->LayerGroups
));
571 fputs ("Styles[\"", FP
);
572 for (group
= 0; group
< NUM_STYLES
- 1; group
++)
573 pcb_fprintf (FP
, "%s,%mr,%mr,%mr,%mr:", PCB
->RouteStyle
[group
].Name
,
574 PCB
->RouteStyle
[group
].Thick
,
575 PCB
->RouteStyle
[group
].Diameter
,
576 PCB
->RouteStyle
[group
].Hole
, PCB
->RouteStyle
[group
].Keepaway
);
577 pcb_fprintf (FP
, "%s,%mr,%mr,%mr,%mr\"]\n\n", PCB
->RouteStyle
[group
].Name
,
578 PCB
->RouteStyle
[group
].Thick
,
579 PCB
->RouteStyle
[group
].Diameter
,
580 PCB
->RouteStyle
[group
].Hole
, PCB
->RouteStyle
[group
].Keepaway
);
583 /* ---------------------------------------------------------------------------
584 * writes font data of non empty symbols
587 WritePCBFontData (FILE * FP
)
593 for (font
= &PCB
->Font
, i
= 0; i
<= MAX_FONTPOSITION
; i
++)
595 if (!font
->Symbol
[i
].Valid
)
599 pcb_fprintf (FP
, "Symbol['%c' %mr]\n(\n", i
, font
->Symbol
[i
].Delta
);
601 pcb_fprintf (FP
, "Symbol[%i %mr]\n(\n", i
, font
->Symbol
[i
].Delta
);
603 line
= font
->Symbol
[i
].Line
;
604 for (j
= font
->Symbol
[i
].LineN
; j
; j
--, line
++)
605 pcb_fprintf (FP
, "\tSymbolLine[%mr %mr %mr %mr %mr]\n",
606 line
->Point1
.X
, line
->Point1
.Y
,
607 line
->Point2
.X
, line
->Point2
.Y
, line
->Thickness
);
612 /* ---------------------------------------------------------------------------
616 WriteViaData (FILE * FP
, DataType
*Data
)
619 /* write information about vias */
620 for (iter
= Data
->Via
; iter
!= NULL
; iter
= g_list_next (iter
))
622 PinType
*via
= iter
->data
;
623 pcb_fprintf (FP
, "Via[%mr %mr %mr %mr %mr %mr ", via
->X
, via
->Y
,
624 via
->Thickness
, via
->Clearance
, via
->Mask
, via
->DrillingHole
);
625 PrintQuotedString (FP
, (char *)EMPTY (via
->Name
));
626 fprintf (FP
, " %s]\n", F2S (via
, VIA_TYPE
));
630 /* ---------------------------------------------------------------------------
631 * writes rat-line data
634 WritePCBRatData (FILE * FP
)
637 /* write information about rats */
638 for (iter
= PCB
->Data
->Rat
; iter
!= NULL
; iter
= g_list_next (iter
))
640 RatType
*line
= iter
->data
;
641 pcb_fprintf (FP
, "Rat[%mr %mr %d %mr %mr %d ",
642 line
->Point1
.X
, line
->Point1
.Y
, line
->group1
,
643 line
->Point2
.X
, line
->Point2
.Y
, line
->group2
);
644 fprintf (FP
, " %s]\n", F2S (line
, RATLINE_TYPE
));
648 /* ---------------------------------------------------------------------------
649 * writes netlist data
652 WritePCBNetlistData (FILE * FP
)
654 /* write out the netlist if it exists */
655 if (PCB
->NetlistLib
.MenuN
)
658 fprintf (FP
, "NetList()\n(\n");
660 for (n
= 0; n
< PCB
->NetlistLib
.MenuN
; n
++)
662 LibraryMenuType
*menu
= &PCB
->NetlistLib
.Menu
[n
];
663 fprintf (FP
, "\tNet(");
664 PrintQuotedString(FP
, &menu
->Name
[2]);
666 PrintQuotedString(FP
, (char *)UNKNOWN (menu
->Style
));
667 fprintf (FP
, ")\n\t(\n");
668 for (p
= 0; p
< menu
->EntryN
; p
++)
670 LibraryEntryType
*entry
= &menu
->Entry
[p
];
671 fprintf (FP
, "\t\tConnect(");
672 PrintQuotedString (FP
, entry
->ListEntry
);
675 fprintf (FP
, "\t)\n");
681 /* ---------------------------------------------------------------------------
682 * writes element data
685 WriteElementData (FILE * FP
, DataType
*Data
)
688 for (n
= Data
->Element
; n
!= NULL
; n
= g_list_next (n
))
690 ElementType
*element
= n
->data
;
692 /* only non empty elements */
693 if (!element
->LineN
&& !element
->PinN
&& !element
->ArcN
696 /* the coordinates and text-flags are the same for
697 * both names of an element
699 fprintf (FP
, "\nElement[%s ", F2S (element
, ELEMENT_TYPE
));
700 PrintQuotedString (FP
, (char *)EMPTY (DESCRIPTION_NAME (element
)));
702 PrintQuotedString (FP
, (char *)EMPTY (NAMEONPCB_NAME (element
)));
704 PrintQuotedString (FP
, (char *)EMPTY (VALUE_NAME (element
)));
705 pcb_fprintf (FP
, " %mr %mr %mr %mr %d %d %s]\n(\n",
706 element
->MarkX
, element
->MarkY
,
707 DESCRIPTION_TEXT (element
).X
- element
->MarkX
,
708 DESCRIPTION_TEXT (element
).Y
- element
->MarkY
,
709 DESCRIPTION_TEXT (element
).Direction
,
710 DESCRIPTION_TEXT (element
).Scale
,
711 F2S (&(DESCRIPTION_TEXT (element
)), ELEMENTNAME_TYPE
));
712 WriteAttributeList (FP
, &element
->Attributes
, "\t");
713 for (p
= element
->Pin
; p
!= NULL
; p
= g_list_next (p
))
715 PinType
*pin
= p
->data
;
716 pcb_fprintf (FP
, "\tPin[%mr %mr %mr %mr %mr %mr ",
717 pin
->X
- element
->MarkX
,
718 pin
->Y
- element
->MarkY
,
719 pin
->Thickness
, pin
->Clearance
,
720 pin
->Mask
, pin
->DrillingHole
);
721 PrintQuotedString (FP
, (char *)EMPTY (pin
->Name
));
723 PrintQuotedString (FP
, (char *)EMPTY (pin
->Number
));
724 fprintf (FP
, " %s]\n", F2S (pin
, PIN_TYPE
));
726 for (p
= element
->Pad
; p
!= NULL
; p
= g_list_next (p
))
728 PadType
*pad
= p
->data
;
729 pcb_fprintf (FP
, "\tPad[%mr %mr %mr %mr %mr %mr %mr ",
730 pad
->Point1
.X
- element
->MarkX
,
731 pad
->Point1
.Y
- element
->MarkY
,
732 pad
->Point2
.X
- element
->MarkX
,
733 pad
->Point2
.Y
- element
->MarkY
,
734 pad
->Thickness
, pad
->Clearance
, pad
->Mask
);
735 PrintQuotedString (FP
, (char *)EMPTY (pad
->Name
));
737 PrintQuotedString (FP
, (char *)EMPTY (pad
->Number
));
738 fprintf (FP
, " %s]\n", F2S (pad
, PAD_TYPE
));
740 for (p
= element
->Line
; p
!= NULL
; p
= g_list_next (p
))
742 LineType
*line
= p
->data
;
743 pcb_fprintf (FP
, "\tElementLine [%mr %mr %mr %mr %mr]\n",
744 line
->Point1
.X
- element
->MarkX
,
745 line
->Point1
.Y
- element
->MarkY
,
746 line
->Point2
.X
- element
->MarkX
,
747 line
->Point2
.Y
- element
->MarkY
,
750 for (p
= element
->Arc
; p
!= NULL
; p
= g_list_next (p
))
752 ArcType
*arc
= p
->data
;
753 pcb_fprintf (FP
, "\tElementArc [%mr %mr %mr %mr %ma %ma %mr]\n",
754 arc
->X
- element
->MarkX
,
755 arc
->Y
- element
->MarkY
,
756 arc
->Width
, arc
->Height
,
757 arc
->StartAngle
, arc
->Delta
,
760 fputs ("\n\t)\n", FP
);
764 /* ---------------------------------------------------------------------------
768 WriteLayerData (FILE * FP
, Cardinal Number
, LayerType
*layer
)
771 /* write information about non empty layers */
772 if (layer
->LineN
|| layer
->ArcN
|| layer
->TextN
|| layer
->PolygonN
||
773 (layer
->Name
&& *layer
->Name
))
775 fprintf (FP
, "Layer(%i ", (int) Number
+ 1);
776 PrintQuotedString (FP
, (char *)EMPTY (layer
->Name
));
777 fputs (")\n(\n", FP
);
778 WriteAttributeList (FP
, &layer
->Attributes
, "\t");
780 for (n
= layer
->Line
; n
!= NULL
; n
= g_list_next (n
))
782 LineType
*line
= n
->data
;
783 pcb_fprintf (FP
, "\tLine[%mr %mr %mr %mr %mr %mr %s]\n",
784 line
->Point1
.X
, line
->Point1
.Y
,
785 line
->Point2
.X
, line
->Point2
.Y
,
786 line
->Thickness
, line
->Clearance
,
787 F2S (line
, LINE_TYPE
));
789 for (n
= layer
->Arc
; n
!= NULL
; n
= g_list_next (n
))
791 ArcType
*arc
= n
->data
;
792 pcb_fprintf (FP
, "\tArc[%mr %mr %mr %mr %mr %mr %ma %ma %s]\n",
793 arc
->X
, arc
->Y
, arc
->Width
,
794 arc
->Height
, arc
->Thickness
,
795 arc
->Clearance
, arc
->StartAngle
,
796 arc
->Delta
, F2S (arc
, ARC_TYPE
));
798 for (n
= layer
->Text
; n
!= NULL
; n
= g_list_next (n
))
800 TextType
*text
= n
->data
;
801 pcb_fprintf (FP
, "\tText[%mr %mr %d %d ",
803 text
->Direction
, text
->Scale
);
804 PrintQuotedString (FP
, (char *)EMPTY (text
->TextString
));
805 fprintf (FP
, " %s]\n", F2S (text
, TEXT_TYPE
));
807 for (n
= layer
->Polygon
; n
!= NULL
; n
= g_list_next (n
))
809 PolygonType
*polygon
= n
->data
;
812 fprintf (FP
, "\tPolygon(%s)\n\t(", F2S (polygon
, POLYGON_TYPE
));
813 for (p
= 0; p
< polygon
->PointN
; p
++)
815 PointType
*point
= &polygon
->Points
[p
];
817 if (hole
< polygon
->HoleIndexN
&&
818 p
== polygon
->HoleIndex
[hole
])
821 fputs ("\n\t\t)", FP
);
822 fputs ("\n\t\tHole (", FP
);
829 fputs ("\n\t\t", FP
);
833 pcb_fprintf (FP
, "[%mr %mr] ", point
->X
, point
->Y
);
836 fputs ("\n\t\t)", FP
);
837 fputs ("\n\t)\n", FP
);
843 /* ---------------------------------------------------------------------------
844 * writes just the elements in the buffer to file
847 WriteBuffer (FILE * FP
)
851 WriteViaData (FP
, PASTEBUFFER
->Data
);
852 WriteElementData (FP
, PASTEBUFFER
->Data
);
853 for (i
= 0; i
< max_copper_layer
+ 2; i
++)
854 WriteLayerData (FP
, i
, &(PASTEBUFFER
->Data
->Layer
[i
]));
858 /* ---------------------------------------------------------------------------
865 if (Settings
.SaveMetricOnly
)
866 set_allow_readable (ALLOW_MM
);
868 set_allow_readable (ALLOW_READABLE
);
870 WritePCBInfoHeader (FP
);
871 WritePCBDataHeader (FP
);
872 WritePCBFontData (FP
);
873 WriteAttributeList (FP
, &PCB
->Attributes
, "");
874 WriteViaData (FP
, PCB
->Data
);
875 WriteElementData (FP
, PCB
->Data
);
876 WritePCBRatData (FP
);
877 for (i
= 0; i
< max_copper_layer
+ 2; i
++)
878 WriteLayerData (FP
, i
, &(PCB
->Data
->Layer
[i
]));
879 WritePCBNetlistData (FP
);
884 /* ---------------------------------------------------------------------------
888 WritePCBFile (char *Filename
)
893 if ((fp
= fopen (Filename
, "w")) == NULL
)
895 OpenErrorMessage (Filename
);
896 return (STATUS_ERROR
);
898 result
= WritePCB (fp
);
903 /* ---------------------------------------------------------------------------
904 * writes to pipe using the command defined by Settings.SaveCommand
905 * %f are replaced by the passed filename
908 WritePipe (char *Filename
, bool thePcb
)
913 static DynamicStringType command
;
916 if (EMPTY_STRING_P (Settings
.SaveCommand
))
918 fp
= fopen (Filename
, "w");
921 Message ("Unable to write to file %s\n", Filename
);
928 /* setup commandline */
929 DSClearString (&command
);
930 for (p
= Settings
.SaveCommand
; *p
; p
++)
932 /* copy character if not special or add string to command */
933 if (!(*p
== '%' && *(p
+ 1) == 'f'))
934 DSAddCharacter (&command
, *p
);
937 DSAddString (&command
, Filename
);
939 /* skip the character */
943 DSAddCharacter (&command
, '\0');
944 printf ("write to pipe \"%s\"\n", command
.Data
);
945 if ((fp
= popen (command
.Data
, "w")) == NULL
)
947 PopenErrorMessage (command
.Data
);
948 return (STATUS_ERROR
);
953 if (PCB
->is_footprint
)
955 WriteElementData (fp
, PCB
->Data
);
959 result
= WritePCB (fp
);
962 result
= WriteBuffer (fp
);
965 return (pclose (fp
) ? STATUS_ERROR
: result
);
966 return (fclose (fp
) ? STATUS_ERROR
: result
);
969 /* ---------------------------------------------------------------------------
970 * saves the layout in a temporary file
971 * this is used for fatal errors and does not call the program specified
972 * in 'saveCommand' for safety reasons
979 /* memory might have been released before this function is called */
980 if (PCB
&& PCB
->Changed
)
982 sprintf (filename
, EMERGENCY_NAME
, (int) getpid ());
983 Message (_("Trying to save your layout in '%s'\n"), filename
);
984 WritePCBFile (filename
);
988 /* ---------------------------------------------------------------------------
989 * front-end for 'SaveInTMP()'
990 * just makes sure that the routine is only called once
992 static bool dont_save_any_more
= false;
997 if (!dont_save_any_more
)
1000 dont_save_any_more
= true;
1005 DisableEmergencySave (void)
1007 dont_save_any_more
= true;
1010 /* ----------------------------------------------------------------------
1011 * Callback for the autosave
1014 static hidval backup_timer
;
1017 * If the backup interval is > 0 then set another timer. Otherwise
1018 * we do nothing and it is up to the GUI to call EnableAutosave()
1019 * after setting Settings.BackupInterval > 0 again.
1022 backup_cb (hidval data
)
1024 backup_timer
.ptr
= NULL
;
1026 if (Settings
.BackupInterval
> 0 && gui
->add_timer
)
1027 backup_timer
= gui
->add_timer (backup_cb
,
1028 1000 * Settings
.BackupInterval
, data
);
1032 EnableAutosave (void)
1038 /* If we already have a timer going, then cancel it out */
1039 if (backup_timer
.ptr
!= NULL
&& gui
->stop_timer
)
1040 gui
->stop_timer (backup_timer
);
1042 backup_timer
.ptr
= NULL
;
1043 /* Start up a new timer */
1044 if (Settings
.BackupInterval
> 0 && gui
->add_timer
)
1045 backup_timer
= gui
->add_timer (backup_cb
,
1046 1000 * Settings
.BackupInterval
,
1050 /* ---------------------------------------------------------------------------
1051 * creates backup file. The default is to use the pcb file name with
1052 * a "-" appended (like "foo.pcb-") and if we don't have a pcb file name
1053 * then use the template in BACKUP_NAME
1058 char *filename
= NULL
;
1060 if( PCB
&& PCB
->Filename
)
1062 filename
= (char *) malloc (sizeof (char) * (strlen (PCB
->Filename
) + 2));
1063 if (filename
== NULL
)
1065 fprintf (stderr
, "Backup(): malloc failed\n");
1068 sprintf (filename
, "%s~", PCB
->Filename
);
1072 /* BACKUP_NAME has %.8i which will be replaced by the process ID */
1073 filename
= (char *) malloc (sizeof (char) * (strlen (BACKUP_NAME
) + 8));
1074 if (filename
== NULL
)
1076 fprintf (stderr
, "Backup(): malloc failed\n");
1079 sprintf (filename
, BACKUP_NAME
, (int) getpid ());
1082 WritePCBFile (filename
);
1086 #if !defined(HAS_ATEXIT) && !defined(HAS_ON_EXIT)
1087 /* ---------------------------------------------------------------------------
1088 * makes a temporary copy of the data. This is useful for systems which
1089 * doesn't support calling functions on exit. We use this to save the data
1090 * before LEX and YACC functions are called because they are able to abort
1096 sprintf (TMPFilename
, EMERGENCY_NAME
, (int) getpid ());
1097 WritePCBFile (TMPFilename
);
1100 /* ---------------------------------------------------------------------------
1101 * removes the temporary copy of the data file
1104 RemoveTMPData (void)
1106 unlink (TMPFilename
);
1110 /* ---------------------------------------------------------------------------
1111 * Parse the directory tree where newlib footprints are found
1114 /* Helper function for ParseLibraryTree */
1116 pcb_basename (char *p
)
1118 char *rv
= strrchr (p
, '/');
1124 /* This is a helper function for ParseLibrary Tree. Given a char *path,
1125 * it finds all newlib footprints in that dir and sticks them into the
1126 * library menu structure named entry.
1129 LoadNewlibFootprintsFromDir(char *libpath
, char *toppath
)
1131 char olddir
[MAXPATHLEN
+ 1]; /* The directory we start out in (cwd) */
1132 char subdir
[MAXPATHLEN
+ 1]; /* The directory holding footprints to load */
1133 DIR *subdirobj
; /* Interable object holding all subdir entries */
1134 struct dirent
*subdirentry
; /* Individual subdir entry */
1135 struct stat buffer
; /* Buffer used in stat */
1136 LibraryMenuType
*menu
= NULL
; /* Pointer to PCB's library menu structure */
1137 LibraryEntryType
*entry
; /* Pointer to individual menu entry */
1140 int n_footprints
= 0; /* Running count of footprints found in this subdir */
1142 /* Cache old dir, then cd into subdir because stat is given relative file names. */
1143 memset (subdir
, 0, sizeof subdir
);
1144 memset (olddir
, 0, sizeof olddir
);
1145 if (GetWorkingDirectory (olddir
) == NULL
)
1147 Message (_("LoadNewlibFootprintsFromDir: Could not determine initial working directory\n"));
1151 if (strcmp (libpath
, "(local)") == 0)
1152 strcpy (subdir
, ".");
1154 strcpy (subdir
, libpath
);
1158 ChdirErrorMessage (subdir
);
1162 /* Determine subdir is abs path */
1163 if (GetWorkingDirectory (subdir
) == NULL
)
1165 Message (_("LoadNewlibFootprintsFromDir: Could not determine new working directory\n"));
1167 ChdirErrorMessage (olddir
);
1171 /* First try opening the directory specified by path */
1172 if ( (subdirobj
= opendir (subdir
)) == NULL
)
1174 OpendirErrorMessage (subdir
);
1176 ChdirErrorMessage (olddir
);
1180 /* Get pointer to memory holding menu */
1181 menu
= GetLibraryMenuMemory (&Library
);
1182 /* Populate menuname and path vars */
1183 menu
->Name
= strdup (pcb_basename(subdir
));
1184 menu
->directory
= strdup (pcb_basename(toppath
));
1186 /* Now loop over files in this directory looking for files.
1187 * We ignore certain files which are not footprints.
1189 while ((subdirentry
= readdir (subdirobj
)) != NULL
)
1192 /* printf("... Examining file %s ... \n", subdirentry->d_name); */
1195 /* Ignore non-footprint files found in this directory
1196 * We're skipping .png and .html because those
1197 * may exist in a library tree to provide an html browsable
1198 * index of the library.
1200 l
= strlen (subdirentry
->d_name
);
1201 if (!stat (subdirentry
->d_name
, &buffer
) && S_ISREG (buffer
.st_mode
)
1202 && subdirentry
->d_name
[0] != '.'
1203 && NSTRCMP (subdirentry
->d_name
, "CVS") != 0
1204 && NSTRCMP (subdirentry
->d_name
, "Makefile") != 0
1205 && NSTRCMP (subdirentry
->d_name
, "Makefile.am") != 0
1206 && NSTRCMP (subdirentry
->d_name
, "Makefile.in") != 0
1207 && (l
< 4 || NSTRCMP(subdirentry
->d_name
+ (l
- 4), ".png") != 0)
1208 && (l
< 5 || NSTRCMP(subdirentry
->d_name
+ (l
- 5), ".html") != 0)
1209 && (l
< 4 || NSTRCMP(subdirentry
->d_name
+ (l
- 4), ".pcb") != 0) )
1212 /* printf("... Found a footprint %s ... \n", subdirentry->d_name); */
1215 entry
= GetLibraryEntryMemory (menu
);
1218 * entry->AllocatedMemory points to abs path to the footprint.
1219 * entry->ListEntry points to fp name itself.
1221 len
= strlen(subdir
) + strlen("/") + strlen(subdirentry
->d_name
) + 1;
1222 entry
->AllocatedMemory
= (char *)calloc (1, len
);
1223 strcat (entry
->AllocatedMemory
, subdir
);
1224 strcat (entry
->AllocatedMemory
, PCB_DIR_SEPARATOR_S
);
1226 /* store pointer to start of footprint name */
1227 entry
->ListEntry
= entry
->AllocatedMemory
1228 + strlen (entry
->AllocatedMemory
);
1230 /* Now place footprint name into AllocatedMemory */
1231 strcat (entry
->AllocatedMemory
, subdirentry
->d_name
);
1233 /* mark as directory tree (newlib) library */
1234 entry
->Template
= (char *) -1;
1237 /* Done. Clean up, cd back into old dir, and return */
1238 closedir (subdirobj
);
1240 ChdirErrorMessage (olddir
);
1241 return n_footprints
;
1245 /* This function loads the newlib footprints into the Library.
1246 * It examines all directories pointed to by Settings.LibraryTree.
1247 * In each directory specified there, it looks both in that directory,
1248 * as well as *one* level down. It calls the subfunction
1249 * LoadNewlibFootprintsFromDir to put the footprints into PCB's internal
1253 ParseLibraryTree (void)
1255 char toppath
[MAXPATHLEN
+ 1]; /* String holding abs path to top level library dir */
1256 char working
[MAXPATHLEN
+ 1]; /* String holding abs path to working dir */
1257 char *libpaths
; /* String holding list of library paths to search */
1258 char *p
; /* Helper string used in iteration */
1259 DIR *dirobj
; /* Iterable directory object */
1260 struct dirent
*direntry
= NULL
; /* Object holding individual directory entries */
1261 struct stat buffer
; /* buffer used in stat */
1262 int n_footprints
= 0; /* Running count of footprints found */
1264 /* Initialize path, working by writing 0 into every byte. */
1265 memset (toppath
, 0, sizeof toppath
);
1266 memset (working
, 0, sizeof working
);
1268 /* Save the current working directory as an absolute path.
1269 * This fcn writes the abs path into the memory pointed to by the input arg.
1271 if (GetWorkingDirectory (working
) == NULL
)
1273 Message (_("ParseLibraryTree: Could not determine initial working directory\n"));
1277 /* Additional loop to allow for multiple 'newlib' style library directories
1278 * called out in Settings.LibraryTree
1280 libpaths
= strdup (Settings
.LibraryTree
);
1281 for (p
= strtok (libpaths
, PCB_PATH_DELIMETER
); p
&& *p
; p
= strtok (NULL
, PCB_PATH_DELIMETER
))
1283 /* remove trailing path delimeter */
1284 strncpy (toppath
, p
, sizeof (toppath
) - 1);
1286 /* start out in the working directory in case the path is a
1289 if (chdir (working
))
1291 ChdirErrorMessage (working
);
1297 * Next change to the directory which is the top of the library tree
1298 * and extract its abs path.
1300 if (chdir (toppath
))
1302 ChdirErrorMessage (toppath
);
1306 if (GetWorkingDirectory (toppath
) == NULL
)
1308 Message (_("ParseLibraryTree: Could not determine new working directory\n"));
1313 printf("In ParseLibraryTree, looking for newlib footprints inside top level directory %s ... \n",
1317 /* Next read in any footprints in the top level dir */
1318 n_footprints
+= LoadNewlibFootprintsFromDir("(local)", toppath
);
1320 /* Then open this dir so we can loop over its contents. */
1321 if ((dirobj
= opendir (toppath
)) == NULL
)
1323 OpendirErrorMessage (toppath
);
1327 /* Now loop over files in this directory looking for subdirs.
1328 * For each direntry which is a valid subdirectory,
1329 * try to load newlib footprints inside it.
1331 while ((direntry
= readdir (dirobj
)) != NULL
)
1334 printf("In ParseLibraryTree loop examining 2nd level direntry %s ... \n", direntry
->d_name
);
1336 /* Find subdirectories. Ignore entries beginning with "." and CVS
1339 if (!stat (direntry
->d_name
, &buffer
)
1340 && S_ISDIR (buffer
.st_mode
)
1341 && direntry
->d_name
[0] != '.'
1342 && NSTRCMP (direntry
->d_name
, "CVS") != 0)
1344 /* Found a valid subdirectory. Try to load footprints from it.
1346 n_footprints
+= LoadNewlibFootprintsFromDir(direntry
->d_name
, toppath
);
1352 /* restore the original working directory */
1353 if (chdir (working
))
1354 ChdirErrorMessage (working
);
1357 printf("Leaving ParseLibraryTree, found %d footprints.\n", n_footprints
);
1361 return n_footprints
;
1364 /* ---------------------------------------------------------------------------
1365 * Read contents of the library description file (for M4)
1366 * and then read in M4 libs. Then call a fcn to read the newlib
1370 ReadLibraryContents (void)
1372 static char *command
= NULL
;
1373 char inputline
[MAX_LIBRARY_LINE_LENGTH
+ 1];
1374 FILE *resultFP
= NULL
;
1375 LibraryMenuType
*menu
= NULL
;
1376 LibraryEntryType
*entry
;
1378 /* If we don't have a command to execute to find the library contents,
1379 * skip this. This is used by default on Windows builds (set in main.c),
1380 * as we can't normally run shell scripts or expect to have m4 present.
1382 if (Settings
.LibraryContentsCommand
!= NULL
&&
1383 Settings
.LibraryContentsCommand
[0] != '\0')
1385 /* First load the M4 stuff. The variable Settings.LibraryPath
1389 command
= EvaluateFilename (Settings
.LibraryContentsCommand
,
1390 Settings
.LibraryPath
, Settings
.LibraryFilename
,
1394 printf("In ReadLibraryContents, about to execute command %s\n", command
);
1397 /* This uses a pipe to execute a shell script which provides the names of
1398 * all M4 libs and footprints. The results are placed in resultFP.
1400 if (command
&& *command
&& (resultFP
= popen (command
, "r")) == NULL
)
1402 PopenErrorMessage (command
);
1405 /* the M4 library contents are separated by colons;
1406 * template : package : name : description
1408 while (resultFP
!= NULL
&& fgets (inputline
, MAX_LIBRARY_LINE_LENGTH
, resultFP
))
1410 size_t len
= strlen (inputline
);
1412 /* check for maximum linelength */
1416 if (inputline
[len
] != '\n')
1418 ("linelength (%i) exceeded; following characters will be ignored\n",
1419 MAX_LIBRARY_LINE_LENGTH
);
1421 inputline
[len
] = '\0';
1424 /* if the line defines a menu */
1425 if (!strncmp (inputline
, "TYPE=", 5))
1427 menu
= GetLibraryMenuMemory (&Library
);
1428 menu
->Name
= strdup (UNKNOWN (&inputline
[5]));
1429 menu
->directory
= strdup (Settings
.LibraryFilename
);
1433 /* allocate a new menu entry if not already done */
1436 menu
= GetLibraryMenuMemory (&Library
);
1437 menu
->Name
= strdup (UNKNOWN ((char *) NULL
));
1438 menu
->directory
= strdup (Settings
.LibraryFilename
);
1440 entry
= GetLibraryEntryMemory (menu
);
1441 entry
->AllocatedMemory
= strdup (inputline
);
1443 /* now break the line into pieces separated by colons */
1444 if ((entry
->Template
= strtok (entry
->AllocatedMemory
, ":")) !=
1446 if ((entry
->Package
= strtok (NULL
, ":")) != NULL
)
1447 if ((entry
->Value
= strtok (NULL
, ":")) != NULL
)
1448 entry
->Description
= strtok (NULL
, ":");
1450 /* create the list entry */
1451 len
= strlen (EMPTY (entry
->Value
)) +
1452 strlen (EMPTY (entry
->Description
)) + 4;
1453 entry
->ListEntry
= (char *)calloc (len
, sizeof (char));
1454 sprintf (entry
->ListEntry
,
1455 "%s, %s", EMPTY (entry
->Value
),
1456 EMPTY (entry
->Description
));
1459 if (resultFP
!= NULL
)
1463 /* Now after reading in the M4 libs, call a function to
1464 * read the newlib footprint libraries. Then sort the whole
1467 if (ParseLibraryTree () > 0 || resultFP
!= NULL
)
1469 sort_library (&Library
);
1476 #define BLANK(x) ((x) == ' ' || (x) == '\t' || (x) == '\n' \
1479 /* ---------------------------------------------------------------------------
1480 * Read in a netlist and store it in the netlist menu
1484 ReadNetlist (char *filename
)
1486 static char *command
= NULL
;
1487 char inputline
[MAX_NETLIST_LINE_LENGTH
+ 1];
1488 char temp
[MAX_NETLIST_LINE_LENGTH
+ 1];
1490 LibraryMenuType
*menu
= NULL
;
1491 LibraryEntryType
*entry
;
1492 int i
, j
, lines
, kind
;
1494 bool used_popen
= false;
1498 return 1; /* nothing to do */
1500 Message (_("Importing PCB netlist %s\n"), filename
);
1502 if (EMPTY_STRING_P (Settings
.RatCommand
))
1504 fp
= fopen (filename
, "r");
1507 Message("Cannot open %s for reading", filename
);
1515 command
= EvaluateFilename (Settings
.RatCommand
,
1516 Settings
.RatPath
, filename
, NULL
);
1518 /* open pipe to stdout of command */
1519 if (*command
== '\0' || (fp
= popen (command
, "r")) == NULL
)
1521 PopenErrorMessage (command
);
1526 /* kind = 0 is net name
1527 * kind = 1 is route style name
1528 * kind = 2 is connection
1531 while (fgets (inputline
, MAX_NETLIST_LINE_LENGTH
, fp
))
1533 size_t len
= strlen (inputline
);
1534 /* check for maximum length line */
1537 if (inputline
[--len
] != '\n')
1538 Message (_("Line length (%i) exceeded in netlist file.\n"
1539 "additional characters will be ignored.\n"),
1540 MAX_NETLIST_LINE_LENGTH
);
1542 inputline
[len
] = '\0';
1544 continued
= (inputline
[len
- 1] == '\\') ? true : false;
1546 inputline
[len
- 1] = '\0';
1549 while (inputline
[i
] != '\0')
1552 /* skip leading blanks */
1553 while (inputline
[i
] != '\0' && BLANK (inputline
[i
]))
1557 /* add two spaces for included/unincluded */
1561 while (!BLANK (inputline
[i
]))
1562 temp
[j
++] = inputline
[i
++];
1564 while (inputline
[i
] != '\0' && BLANK (inputline
[i
]))
1568 menu
= GetLibraryMenuMemory (&PCB
->NetlistLib
);
1569 menu
->Name
= strdup (temp
);
1575 if (kind
== 1 && strchr (temp
, '-') == NULL
)
1578 menu
->Style
= strdup (temp
);
1582 entry
= GetLibraryEntryMemory (menu
);
1583 entry
->ListEntry
= strdup (temp
);
1592 Message (_("Empty netlist file!\n"));
1603 static int ReadEdifNetlist (char *filename
);
1605 int ImportNetlist (char *filename
)
1613 if (!filename
) return (1); /* nothing to do */
1614 fp
= fopen (filename
, "r");
1615 if (!fp
) return (1); /* bad filename */
1616 i
= fread (buf
, 1, sizeof(buf
)-1, fp
);
1622 *p
= tolower ((int) *p
);
1625 p
= strstr (buf
, "edif");
1626 if (!p
) return ReadNetlist (filename
);
1627 else return ReadEdifNetlist (filename
);
1630 static int ReadEdifNetlist (char *filename
)
1632 Message (_("Importing edif netlist %s\n"), filename
);
1633 ParseEDIF(filename
, NULL
);