Drawing API refactor

more chopping

Just start chopping things

Push special case thindraw vs. fill polygon handling into the GUIs

This causes some code duplication, but it keeps the GUI specific
functionality a little cleaner.

hid/png: Don't use the core's drawing functions

hid/gerber: Don't use the core's drawing functions

hid/ps/eps.c: Don't use core drawing routines

hid/ps: Don't use the core's drawing functions

XI2 HACK TEST

Currently PCB user can draw arcs at limited angles (usually 90 degree step), though there is no such internal limit for arcs angles.

Now the patched tool is expected to work like this:
1.point at the center,
2.the first point of arc
  (up to 270 degrees; sets the arc direction),
3.the second point of arc (the direction is the same as at the end
  of 2.; when the new arc overlaps the arc drawn in step 2., a full
  circle is created);
4.return to 3. until ESC (`F3' moves the starting point
  to end of the latest arc and returns to 3.)

During 3. and 4. Shift-click moves the center of the arc
to the pointer.

Switching from/to Line tool draws chained segments.

HOW TO TEST
Select Arc tool; draw different arcs with lines
pressing different buttons, and `F2', `F3' and `U' keys.

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>
Modified-by: Peter Clifton <Peter.Clifton@clifton-electronics.co.uk>
     Updated to suit HID API changes
     Removed a couple of unused variables
     Squashed nasty trailing whitespace

Split out drawing routines into vfunc table for possible replacement

The aim here is to indirect calls to the various drawing routines such
that a GUI or renderer implementation may swap out different parts of
the rendering operation at will without having to re-implement the
entire drawing stack from scratch.

Each drawing API call will now be passed the drawing API structure as
its first parameter, so we don't rely on this being a global.

As a further clean-up, the graphics context being used by the rendering
routines is now a member of the vfunc table structure. We currently
retain the old Output.*gc members, but only use them (where necessary)
to update the ->gc member of the drawing API structure as rendering
progresses.

Move HID drawing API prototypes into a separate header file

Due to the mess of places we define various things in and the order
we pull in headers, we cannot easily create APIs in hid.h which rely
on being passed PCB data-structures.

Rename HID_DRAW_API to just HID_DRAW

Just because its neater

Add strings to translation

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

Updated Russian translation

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

Revert moving common_draw_helpers_init() call in lesstif and GTK HIDs

Not a functional change.. I'm just being anal and wishing to keep these
matching the other HIDs.

HID: Merge {fill/thindraw}_pcb_* APIs into HID_DRAW_API structure

I wanted to keep these separate from the pure graphics APIs, but
after poking at this more and more, it seems hard to justify why
we should do that.

autoroute.c: Destroy debug graphics context when we're finished with it

I caught this one by inspection, as we don't tend to build with autorouter
debugging enabled. I tested quickly before comitting, and this change
doesn't break anything. This said, I couldn't see any debug rendering
output either (before or after this patch).. so that might be broken
somewhere.

hid/lpr: Don't initiialise the graphics API vtable

Just being picky here..

I spent ages trying to work out why the old code didn't segfault, given
it does not call common_draw_helpers_init() to setup the various pad,
pin and polygon drawing routines.

It turns out that when we actually go to export, we call into the ps HID
directly - and ignore the lpr.c HID vtables.

Lets avoid confusion by partly setting up the lpr vtables, and leave the
graphics HID member as NULL.

hid/batch: Fix build after splitting out graphics APIs

I forgot this one, along with build-testing lesstif - oops.

Fixes breakage from commit 273b243d90cda84e09f52b7ff995fa82afdc3de0
           and from commit 741f203565ba9f92b0ace80d858073f75ced2716

draw.c: Add hidGC parameter to DrawTextLowLevel() function

Avoid it assuming the correct gc to use is Output.fgGC

draw.c: Add gc parameter to _draw_line() function

Avoid it assuming the correct GC is Output.fgGC

Make lesstif_hid struct static again

Changed to non-static un-necessarily in commit
a1d8ee04cc571cca4cbe7ef86b40bef612a0c387

lesstif: corrections on recent HID API changes.

Reported by Eugene Mikhantiev <mikhantiev@gmail.com>

PCB can not be built with `--with-gui=lesstif' due to the
HID API changes in commit 73b243d90cda84e09f52b7ff995fa82afdc3de0

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

configure.ac: fixed a typo.

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

Stop "find connected" following rat-lines. Fixes confusing output.

Suppose we have two nets, A and B, and some components. If we connect
a pin of a component which was supposed to be connected to net A, to
net B, the "f" (find connected) action will falsely show the entirity
of net A and net B connected to each other. In reality, the nets are
not electrically connected, it is just the ratline between the
mis-connected component pin (mis-connected to Net B), and net A,
where the ratline for that pin should end up.

It MIGHT be better if we fix this bug by not adding rat-lines to shorted
connections, as often those rat-lines would take some convoluted route
through the copper of the net which is shorted to that connection
end-point. These rat-line(s) would no longer be spatially associated
with the mis-connected wiring, and encourage the user to further short
net A and net B together to complete the ratline.

This bug was a contributing factor to a mistake in a production board
I made recently, where as a last step in production, I added a star-
ground short between two different ground planes (analogue and digital).
The "find connected" action, "f" showed them connected together (as I
expected), but unfortunately, due to a thermal I left out, they were not
actually connected - despite PCB's green rendering suggesting that they
were.

HID: Move non-PCB specific drawing calls into a separate API

hid/gcode: Make gcode_hid structure static

Convert mask type to enum

Convert argument in HID_Flags to (void *) rather than (int)

void * allows us to pass pointers on all platforms, 64bit or
otherwise. We can still use casting macros to safely pass integer
values via this pointer.

Avoids the ugliness of castnig a size_t sized offset_of value into
an int. Due to the size of our structures, this did not cause any
actual bugs, but was not good practice.

Remove unused references to SwitchDrawingWindow()

Remove unused prototypes SetZoom and RedrawZoom, along with old #ifdef'd code

SetZoom() was removed in commit 94e927e03850bfc0e8a0f3b161ae99b6784747f0

There were a few references to SetZoom left under an #ifdef HAVE_LIBSTROKE,
which will not work, so I have commented those as well.

Remove unused zoom settings from the PCB and settings data-structures

parse_y.y: As of November 2012 the cursor position is not written to file anymore

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

Removed the cursor position from being written to the pcb file.

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

hid/common/hidgl: Add API to initialise a rendering pass

Serves as a place to perform any necessary initialisation within hidgl.c,
saving lots of separate calls being made by its callers.

Fix outline drawing to only apply on copper layers

This matches the old comments in the code, and fixes (removes) outline
drawing on the solder mask prints.

This partially reverts commit 294494e56695251e63c0da9f243d6f59447f1c9f
"Fix PS rect/outline logic", which changed the logic, and
commit d2458383a60b670ad1c42163ac24fcc63fcab457 where I changed
the comment to match the code.

hid/gtk: Fix stupid (missing semicolon) bug breaking compile

I was _sure_ I'd buid tested this before pusing... obviously not!

hid/gtk: Avoid using g_object_{set,set}_data() where we don't need to

Personally I hate to see data stashed and recalled with these functions,
especially where is just a case of passing appropriate data to callback
functions.

Use trackball to allow rotation of 3D view

hid/gtk: Make the trackball widget sexy

* Use cairo to render a nice sphere with radial gradients.
* Use widget sensitivity of the track-ball drawing to better.
  differentiate between 2D / 3D views.
* Allow double-clicking on the track-ball to reset the 3D view.

Add virtual trackball code

hid/gtk: Add feature to force an immediate redraw if framerate is low

If more than a certain time (currently hard-coded at 50ms) has elapsed
since the last expose callback, invalidate_all() will wait and process
updates before returning.

This is handy to allow animation of auto-router progress, where the gui
mainloop is not hit until the auto-routing operation is fully complete.

gocde HID: refresh all the G-code exporter tests.

There have been a lot of new features recently and a bunch
of comments refinements. Also the default unit was changed
from inch to mm, so don't be surprised too much there's
nothing left as before. All new test results have been
hand-verified in a G-code viewer.

testsuite: regenerate also Makefile.am.

Previously, running ./run_tests.sh --regen <some test>
would have simply deleted Makefile.am, which is required by
the automatic Makefile generation mechanism. Now this file is
regenerated properly, too.

testsuite: limit regenerations to one test at a time.

Previously, an accidental "./run_tests.sh --regen" without
arguments would regenerate all tests, causing a big mess.

gcode HID: don't predrill drillmill holes.

As mill bits - in opposite to drill bits - are expected to be
stiff, predrilling drillmill holes is a waste of time.

gcode HID: remove an obsolete TODO comment.

Units come along in groups, units other than mm and inch should
be handled properly already.

gcode HID: don't drill drillmill holes.

Actually, this just avoids writing out the drill G-code file for
sizes >= drillmill diameters. While files written out can be
ignored, not writing them should reduce confusion among all the
written files.

gcode HID: implement drill-milling.

This is, if a hole is equal or bigger than the milling tool,
use the milling tool instead of a drill tool to manufacture
the hole. Big advantage is, milling tools can create holes
of arbitrary sizes by moving a circle.

The feature is optional, on by default.

G02/G03 circle movements are avoided, as not all machine
controllers understand them. Instead, a polygon is milled,
with enough sides to stay for any hole size  within the user
choosen accuracy.

If the hole is only slightly bigger than the mill tool, don't
move the circle; a simple plunge is enough.

Correction of two typos.

Closes-bug: lp-1072285

Signed-off-by: Bert Timmerman <bert.timmerman@xs4all.nl>

pcbdiff: add PCBDIFF_DPI to allow user-defined resolution.

This should be the last part of fixing bug #1045907.

pcbdiff: take out --only-visible.

This option leads to PNGs of different sizes and making stereo
images of PNGs of different sizes is (apparently) not possible.

pcbdiff: allow spaces in file names / file paths.

pcbdiff: add a level of abstraction for binaries.

This may help for future developments, where searching in places
other than PATH may be advised. It helps right now for quick
debugging hacks.

Improve documentation of ChangeLog file

Note in the file where it comes from.
Mention it and git commit messages in the README.

fix a format string mismatch

replace gpleda.org with geda-project.org

gcode HID: add user defined feedrates for outline milling.

This includes two new fields in the GUI, as plunging (moving into
the material) has a different feedrate than the normal feedrate now.
These different feedrates are needed by many tools, e.g. end mills.

gcode HID: add user defined feedrates for drilling.

This includes a new field in the GUI.

gcode HID: add user defined feedrates for isolation milling.

This includes two new fields in the GUI, as plunging (moving into
the material) has a different feedrate from the normal feedrate now.
These different feedrates are needed by many tools, e.g. end mills.

gcode HID: move all the code common on file open into a subroutine.

gcode HID: remove an unused struct.

The common HID code has now a better alternative, anyways, so
it's unlikely this will ever be used again.

gcode HID: fix a potential memory leak.

gcode HID: correct a few comments.

gcode HID: create G-code for milling the outline of the board.

This is a rarther simple implementation, which mills a rectangle
with the maximum extents of the board.

gcode HID: reorder user interface to a more logical sequence.

The new sequence is: general - isolation milling - drilling -
milling - output options.

Also completed the term "mill" to "iso-mill", as outline milling
is around the corner.

Default measurement unit changed to mm, as I'm not aware of a
single machine accepting "mil" as G-code unit.

gcode HID: another few cleanups.

gcode HID: release the PNG a lot earlier.

gcode HID: rename gcode_f2 to gcode_f.

... as there's no longer a gcode_f used.

gcode HID: make usage of gcode_f local.

There's no need to keep a file open all the time, all the
processing is done in memory.

gcode HID: simplify the backside flipping algorithm.

As the PNG has to be copied to a bitmap anyways, this can also
be used to flip the back layer.

The code flipping the PNG is still in place, but only needed
for the PNG written do a file (for error checking).

gcode HID: remove an untrue comment.

Actually, gdImageCreate() creates an pallette-based image.

gcode HID: fix the bug producing an inverted image.

For copying an pallette-based image, the pallette has to be
copied, too.

gcode HID: make G-code output aware of dynamic extents.

This also offsets the produced G-code so the rectangular edge
closest to {0, 0} in pcb is {0, 0} in the G-code. Very useful
when actually producing boards.

The most simple way to achieve this is to draw just the part
inside the outline into the intermediate image. No change to
the PNG tracer needed.

Unfortunately, this exposes a bug, making the traced PNG
image inverted. This will be fixed with the next commit.

make EPS boundingbox parameters integers Currently, the bounding box parameters given in the header of an EPS file are floats. The standard calls for integers, though. Some applications like epstool fail if the boundingbox is anything but integer. This patch uses llrint() to output the nearest integer as bounding box parameters. In addition, it adds a high resolution header for the benefit of applications that can use the extra precision.

 Example of the bounding box lines produced by the patch:
 %%BoundingBox: 0 0 370 426
 %%HiResBoundingBox: 0.000000 0.000000 369.503937 426.196850

 Closes-bug: lp-1035999

gcode HID: add header required for UpdateExtents().

gcode HID: write board size according to dynamic extent.

This isn't much, so far, more on dynamic extent to come.

gcode HID: make gcode_toolradius an int.

It's always used as such.

Introduce dynamic board size.

The goal is to eventually define the board's extent by the outline
layer, only. That way, all the exporters can export properly
sized layouts.

Undoubtly, this can also influence the GUIs. For example, "zoom to fit"
becomes a slightly different meaning and drawing outside the board's
extent becomes possible. Autorouting and similars can be limited to
the actual board size. Resizing a board to the lower left no longer
requires the error-prone moving of all the stuff and keeps file diffs
small.

gcode HID: write drill size into the file, too.

So far, drill size was given by the file name only, which can
change accidently.

gcode HID: implement predrilling

Predrilling is using the milling tool to mark all drill spots. This
eases and enhances accuracy of manual drilling.

This resolves patch #12 and obsoletes patch #11 and #13 of
Traumflug's wishlist:
https://bugs.launchpad.net/pcb/+bug/699497

The difference between patch #12 and this patch is, drills
for predrilling are sorted regardless of size, so performance
should be better.

gtk: point file selector dialogs at the current directory

Recent Gtk versions (at least 3 and onward) have broken the file
selection dialog in the case that no default directory was specified:
rather than using the current working directory, it uses a fake
"Recently Chosen Items" directory, from which save/load doesn't work.

This patch fixes the behavior.

Commit by Andrew Poelstra

gerber: Implement option for metric output

Compiles cleanly, all tests pass, default behaviour is completely
unchanged. --Andrew

Fix comments in golden samples for hid_bom[123] tests

With the nanometers switchover, a comment in the BOM output changes
from "output in mils" to "output in mil", breaking tests.

Fix bom.c behavior regarding xy-in-mm option

If the --xy-in-mm option is passed, that should override any other
unit selection behavior (since this is a legacy option, so anyone
using it is not expecting the new many-unit features).

Also, fix a test-breaking change in output precision.

This has apparently been broken since da403312 (audit bom.c for
the nanometers switchover), but was only noticed recently when the
HID tests were fixed.

Fix bom HID tests after commit d30d3142 changed the line ordering

Due to changes in macro.h, the ordering of the BOM output changed,
causing test failures.

Add options to change photo-mode colors.

Original patchset by Benjamin Bergman. Minor changes from
Andrew Poelstra.

Closes-bug: lp-1004796

Fix ps-bloat logic

The ps-bloat option was using the int_value field instead of the
coord-value field, resulting in a bloat of zero all the time.  Fixed.

Remove manhattan check from rats.c

Since commit 644f8d9, I cannot get the autorouter to segfault when
it attempts to deal with ratlines connected to non-manhattan lines.
So, I see no reason not to draw such lines in the first place.

However, when the autorouter is used, it will ignore any rats which
lead to a non-manhattan line. (And therefore not connect two points,
if the shortest connection would involve connecting diagonal traces.)

This is unexpected behavior, though IMO no more unexpected than the
old behavior, which was to ignore diagonal line segments and simply
route amongst the manhattan ones.

Closes-bug: lp-699248

Fix segfault when routing to non-straight pads

Since the autorouter does not handle non-manhattan lines, it will
not route to non-straight pads. Therefore, when the autorouter
searches for the pins/pads at the endpoints of a rat, it ignores
any non-straght pads, returning NULL from the search.

The autorouter then tries to dereference this pointer and crashes.

The rest of the code, it seems, works to avoid ever giving such
rats to the autorouter, but it can be done if the user explicitly
selects such a rat and selects "Auto-route selected rats".

This patch catches the NULL pointer and simply ignores the rat.

It is possible that this is the cause of bug lp-699255, but this
seems unlikely, since the backtrace on that report does not show
the same NULL dereference, and the reporter was using "10-pin
headers", which presumably have no pads that could be marked as
non-straight.

Affects-bug: lp-699255

Wrap gcode_do_export in setlocale() calls

During gcode export, we temporarily switch locales to C to
ensure that output uses the proper decimal separator.

Closes-bug: lp-912077

Fix infinite loop on PCB::skip-drc attribute

When doing a DRC check, pcb skips checking any layers who have the
PCB::skip-drc attribute set. However, when determining whether the
check is complete (via the ListsEmpty()) function, it doesn't skip
these layers.

The result is an infinite loop, since if there is work to be done
on a skip-drc layer, the checker will keep running until it is done
-- i.e., will keep running forever.

This patch skips skip-drc layers in ListsEmpty().

Closes-bug: lp-829123

Make SelectLayer() respond to layer name as well as index

Closes-bug: lp-699470

Parse floating-point values without leading 0 correctly

Closes-bug: lp-916984

Add missing const in lesstif/main.c

Allow saving of user increment settings in Gtk.

It seems there is no clean way of implementing this without really
tearing up the setting-saving code and fixing the SettingType/PCBType
dichotomy, but at 26 lines, this was at least short.

Closes-bug: lp-699464

Save CONFIG_Coord settings in Gtk

The "Safe board width as default" checkbox has not been working
since commit fa2a0e35 back in August, when I added HID_Coord and
CONFIG_Coord to a couple of enums and forgot to update a switch
statement.

This patch fixes that. :-}

Add grid-increment-mm (and similar) settings

Added the following settings:

  grid-increment-mm       grid-increment-mil
  size-increment-mm       size-increment-mil
  line-increment-mm       line-increment-mil
  clear-increment-mm     clear-increment-mil

These behave differently than the old settings of the same names (from
20090929 and earlier). They take a measure, not a real number. The -mm
versions affect the increment settings when the user is using a metric
grid, and the -mil versions affect the settings for imperial grids.

Old ~/.pcb/preferences files likely have lines like

  grid-increment-mil = 5

which have been hanging around for several pcb versions. These should
be safely ignored, since, for example, "5" is now read as "5nm", which
is well below the minimum allowed increment setting.

These settings can be read but (so far) not written out, either to the
pcb or to the preferences file.

Add separate metric and imperial increment settings to Gtk gui.