Merge branch 'master' into japanese-translations

doxygen/versioning.dox

@@ -2,10 +2,10 @@
 @page versioning Version Number
 
 @section main-version Main Versioning Scheme
-The version number of this application consists of a given version in the format of 'v1.0'.
-Where the first number indicates a major release and the second number indicates minor changes.
+The version number of this application consists of a given version in the format of 'v1.0.0' (formely only 2 digits).
+Where the first number indicates a major release and the second and third numbers indicate minor changes.
 
-Versions, including release candidates and path-levels, are tagged in git.
+Versions, including release candidates and patch-levels, are tagged in git.
 
 @subsection rc Release Candidates
 Release candidates are software versions that seem stable and functional to become a new version but testing is not fully finished. These versions are marked with an '-rcX', where X is the number of the release candidate.
@@ -13,7 +13,7 @@ The 3rd release candidate of version 4.2 would be '*v4.2-rc3*'.
 Release candidates are in a frozen state. Only bugfixes that are necessary for functionality are applied to these versions before releasing the final version.
 
 @subsection patch-level Patch Levels
-If an already released version contains bugs that need to be fixed, the version number is not incremented. Insted a new version number with a patch-level is created. The patch-level is appended with a dash directly after the version number. The fist patch-level of version 3.5 would be: 'v3.5-1'.
+If an already released version contains bugs that need to be fixed, the version number is not incremented. Insted a new version number with a patch-level is created. The patch-level is appended with a dash directly after the version number. The fist patch-level of version 3.5.2 would be: 'v3.5.2-1'.
 
 
 @section git-version-num Git Based Version Number

geometric/bounding-box.c

@@ -37,7 +37,7 @@
 #define MAX(a, b) (((a) > (b)) ? (a) : (b)) /**< @brief Return bigger number */
 #define ABS_DBL(a) ((a) < 0 ? -(a) : (a))
 
-void bounding_box_calculate_polygon(GList *vertices, conv_generic_to_vector_2d_t conv_func, union bounding_box *box)
+void bounding_box_calculate_from_polygon(GList *vertices, conv_generic_to_vector_2d_t conv_func, union bounding_box *box)
 {
 	double xmin = DBL_MAX, xmax = -DBL_MAX, ymin = DBL_MAX, ymax = -DBL_MAX;
 	struct vector_2d temp_vec;
@@ -68,7 +68,7 @@ void bounding_box_calculate_polygon(GList *vertices, conv_generic_to_vector_2d_t
 	box->vectors.upper_right.y = ymax;
 }
 
-void bounding_box_update_box(union bounding_box *destination, union bounding_box *update)
+void bounding_box_update_with_box(union bounding_box *destination, union bounding_box *update)
 {
 	if (!destination || !update)
 		return;
@@ -151,8 +151,6 @@ void bounding_box_update_with_path(GList *vertices, double thickness,
 	GList *vertex_iterator;
 	struct vector_2d pt;
 
-	/* printf("Warning! Function %s not yet implemented correctly!\n", __func__); */
-
 	if (!vertices || !box)
 		return;
 
@@ -173,7 +171,7 @@ void bounding_box_update_with_path(GList *vertices, double thickness,
 	}
 }
 
-void bounding_box_update_point(union bounding_box *destination, conv_generic_to_vector_2d_t conv_func, void *pt)
+void bounding_box_update_with_point(union bounding_box *destination, conv_generic_to_vector_2d_t conv_func, void *pt)
 {
 	struct vector_2d point;
 
@@ -224,7 +222,7 @@ void bounding_box_apply_transform(double scale, double rotation_deg, bool flip_a
 		vector_2d_rotate(&input_points[i], rotation_deg * M_PI / 180.0);
 		vector_2d_scale(&input_points[i], scale);
 
-		bounding_box_update_point(box, NULL, &input_points[i]);
+		bounding_box_update_with_point(box, NULL, &input_points[i]);
 	}
 }
 

geometric/cell-geometrics.c

@@ -53,7 +53,7 @@ static void update_box_with_gfx(union bounding_box *box, struct gds_graphics *gf
 	case GRAPHIC_BOX:
 		/* Expected fallthrough */
 	case GRAPHIC_POLYGON:
-		bounding_box_calculate_polygon(gfx->vertices,
+		bounding_box_calculate_from_polygon(gfx->vertices,
 							(conv_generic_to_vector_2d_t)&convert_gds_point_to_2d_vector,
 							&current_box);
 		break;
@@ -74,7 +74,7 @@ static void update_box_with_gfx(union bounding_box *box, struct gds_graphics *gf
 	}
 
 	/* Update box with results */
-	bounding_box_update_box(box, &current_box);
+	bounding_box_update_with_box(box, &current_box);
 }
 
 void calculate_cell_bounding_box(union bounding_box *box, struct gds_cell *cell)
@@ -113,7 +113,7 @@ void calculate_cell_bounding_box(union bounding_box *box, struct gds_cell *cell)
 		temp_box.vectors.upper_right.y += sub_cell->origin.y;
 
 		/* update the parent's box */
-		bounding_box_update_box(box, &temp_box);
+		bounding_box_update_with_box(box, &temp_box);
 	}
 }
 

include/gds-render/geometric/bounding-box.h

@@ -35,15 +35,44 @@
 #include <gds-render/geometric/vector-operations.h>
 #include <stdbool.h>
 
+/**
+ * @brief Union describing a bounding box
+ *
+ * Two ways of accessing a bounding box are possible.
+ *
+ * Either, use the "named" vectors struct to specifically access the points
+ * @code
+ * 	lower_left = box.vectors.lower_left;
+ * 	upper right = box.vectors.upper_right;
+ * @endcode
+ *
+ * or use the iterable vector array:
+ * @code
+ * 	for (i = 0; i < 2; i++)
+ * 		box.vector_array[i] = points[i];
+ * @endcode
+ */
 union bounding_box {
-	/** Coordinate System is (y up | x right) */
+	/**
+	 * @brief Location vectors of upper right and lower left bounding box points
+	 * @note Coordinate System is (y up | x right)
+	 */
 	struct _vectors {
+		/** @brief Lower left point of the bounding box */
 		struct vector_2d lower_left;
+		/** @brief Upper right point of the bounding box */
 		struct vector_2d upper_right;
 	} vectors;
+	/**
+	 * @brief Array of vectors representing a bounding box
+	 * @note This is more convenient for iterating
+	 */
 	struct vector_2d vector_array[2];
 };
 
+/*
+ * @brief Pointer to a function that takes any pointer and converts this object to a vector_2d struct
+ */
 typedef void (*conv_generic_to_vector_2d_t)(void *, struct vector_2d *);
 
 /**
@@ -52,14 +81,14 @@ typedef void (*conv_generic_to_vector_2d_t)(void *, struct vector_2d *);
  * @param conv_func Conversion function to convert vertices to vector_2d structs.
  * @param box Box to write to. This box is not updated! All previous data is discarded
  */
-void bounding_box_calculate_polygon(GList *vertices, conv_generic_to_vector_2d_t conv_func, union bounding_box *box);
+void bounding_box_calculate_from_polygon(GList *vertices, conv_generic_to_vector_2d_t conv_func, union bounding_box *box);
 
 /**
  * @brief Update an exisitng bounding box with another one.
  * @param destination Target box to update
  * @param update Box to update the target with
  */
-void bounding_box_update_box(union bounding_box *destination, union bounding_box *update);
+void bounding_box_update_with_box(union bounding_box *destination, union bounding_box *update);
 
 /**
  * @brief Prepare an empty bounding box.
@@ -76,7 +105,7 @@ void bounding_box_prepare_empty(union bounding_box *box);
  * @param conv_func Conversion function to convert \p pt to a vector_2d. May be NULL
  * @param pt Point to update bounding box with
  */
-void bounding_box_update_point(union bounding_box *destination, conv_generic_to_vector_2d_t conv_func, void *pt);
+void bounding_box_update_with_point(union bounding_box *destination, conv_generic_to_vector_2d_t conv_func, void *pt);
 
 /**
  * @brief Return all four corner points of a bounding box
@@ -102,7 +131,7 @@ void bounding_box_get_all_points(struct vector_2d *points, union bounding_box *b
  * @param rotation_deg Rotation of bounding box around the origin in degrees (counterclockwise)
  * @param flip_at_x Flip the boundig box on the x axis before rotating.
  * @param box Bounding box the operations should be applied to.
- * @note Keep in mind, that this bounding boxy is actually the bounding box of the rotated boundig box and not the object itself.
+ * @note Keep in mind, that this bounding box is actually the bounding box of the rotated boundig box and not the object itself.
  *       It might be too big.
  */
 void bounding_box_apply_transform(double scale, double rotation_deg, bool flip_at_x, union bounding_box *box);
@@ -113,6 +142,9 @@ void bounding_box_apply_transform(double scale, double rotation_deg, bool flip_a
  * @param thickness Thisckness of the path
  * @param conv_func Conversion function for vertices to vector_2d structs
  * @param box Bounding box to write results in.
+ * @warning This function is not yet implemented correctly. Miter points of paths are not taken into account.
+ *		If a path is the outmost object of your cell _and_ it is not parallel to one of the coordinate axes,
+ *		the calculated bounding box size might be off. In other cases it should be reasonable close to the real bounding box.
  */
 void bounding_box_update_with_path(GList *vertices, double thickness, conv_generic_to_vector_2d_t conv_func, union bounding_box *box);
 

output-renderers/cairo-renderer.c

@@ -275,12 +275,20 @@ static int cairo_renderer_render_cell_to_vector_file(GdsOutputRenderer *renderer
 		goto ret_parent;
 	}
 
-	/* Close stdin and (stdout and stderr may live on) */
+	/* We are now in a separate process just for rendering the output image.
+     * You may print a log message to the activity bar of the gui by writing a line
+     * teminated with '\n' to comm_pipe[1]. This will be handled by the parent process.
+     * Directly calling the update function 
+     *     gds_output_renderer_update_async_progress()
+     * does not have any effect because this is a separate process.
+     */
+  
+	/*
+     * Close stdin and (stdout and stderr may live on)
+     */
 	close(0);
-	//close(1);
 	close(comm_pipe[0]);
 
-
 	layers = (struct cairo_layer *)calloc(MAX_LAYERS, sizeof(struct cairo_layer));
 
 	/* Clear layers */

translations/.gitignore

@@ -0,0 +1 @@
+*.mo

translations/pot/po/de/gds-render.po

@@ -1,7 +1,7 @@
 # German translations for gds-render package.
 # Copyright (C) 2019 THE gds-render'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the gds-render package.
-# マリオ <mario.huettel@gmx.net>, 2019.
+# Mario Hüttel <mario.huettel@gmx.net>, 2019.
 #
 msgid ""
 msgstr ""

translations/pot/po/ja/gds-render.po

@@ -0,0 +1,460 @@
+# Japanese translations for gds-render package.
+# Copyright (C) 2019 THE gds-render'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the gds-render package.
+# Mario Hüttel <mario.huettel@gmx.net>, 2019.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: gds-render\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-12-16 18:27+0100\n"
+"PO-Revision-Date: 2020-01-16 22:54+0100\n"
+"Last-Translator: Mario Hüttel <mario.huettel@gmx.net>\n"
+"Language-Team: Japanese <translation-team-ja@lists.sourceforge.net>\n"
+"Language: ja\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"X-Generator: Poedit 2.2.4\n"
+
+#: ../main.c:97
+#, c-format
+msgid ""
+"\n"
+"\n"
+"Full git commit: %s"
+msgstr ""
+"\n"
+"\n"
+"git コミット: %s"
+
+#: ../main.c:294
+msgid " FILE - Convert GDS file <FILE> to graphic"
+msgstr " ファイル - ファイルを変換する"
+
+#: ../resources/about.glade:10
+msgid "!! Replaced during runtime !!"
+msgstr "!! ランタイムで代わる !!"
+
+#: ../command-line.c:205
+#, c-format
+msgid "%d reference loops found.\n"
+msgstr "%d 参照ループが見つかりました.\n"
+
+#: ../main.c:220
+msgid "About"
+msgstr "情報"
+
+#: ../main.c:290
+msgid "Argument string passed to render lib"
+msgstr "レンダリングに渡されるデタ"
+
+#: ../resources/main.glade:225
+msgid "Automatically color layers"
+msgstr "レイヤーを自動的に色付けする"
+
+#: ../resources/main.glade:255
+msgid "Automatically name layers"
+msgstr "レイヤーに自動的に名前を付ける"
+
+#: ../gds-utils/gds-tree-checker.c:71
+#, c-format
+msgid "Broken cell list item found in cell %s. Will continue.\n"
+msgstr "%sのセルで壊れたセルリストアイテムが見つかりました。続けます。\n"
+
+#: ../gds-utils/gds-tree-checker.c:57
+#, c-format
+msgid "Broken cell list item found. Will continue.\n"
+msgstr "壊れたセルリストアイテムが見つかりました。続けます。\n"
+
+#: ../output-renderers/cairo-renderer.c:409
+#, c-format
+msgid "Cairo export finished. It might still be buggy!\n"
+msgstr "Cairoの変換が終了しました.\n"
+
+#. Execute
+#: ../output-renderers/external-renderer.c:120
+msgid "Calling external renderer."
+msgstr "外部レンダラーの実行。"
+
+#: ../gds-render-gui.c:286 ../widgets/conv-settings-dialog.c:291
+msgid "Cancel"
+msgstr "キャンセル"
+
+#: ../gds-render-gui.c:244
+msgid "Cell"
+msgstr "セル"
+
+#: ../command-line.c:209
+#, c-format
+msgid "Cell is affected by reference loop. Abort!\n"
+msgstr "このセルに参照ループがあります。アボート！\n"
+
+#: ../main.c:284
+msgid "Cell to render"
+msgstr "レンダリングされるセル"
+
+#: ../command-line.c:215
+#, c-format
+msgid ""
+"Cell was not checked. This should not happen. Please report this issue. Will "
+"continue either way.\n"
+msgstr "セルのチェックはしませんでした。これは問題です。\n"
+
+#: ../command-line.c:202
+#, c-format
+msgid "Checking library %s failed.\n"
+msgstr "ライブラリ %s のチェックは失敗しました。\n"
+
+#: ../resources/dialog.glade:79
+msgid "Configure LaTeX as standalone document"
+msgstr ""
+
+#: ../resources/main.glade:109
+msgid "Convert selected cell"
+msgstr ""
+
+#: ../output-renderers/external-renderer.c:89
+#, c-format
+msgid ""
+"Could not load external library '%s'\n"
+"Detailed error is:\n"
+"%s\n"
+msgstr ""
+
+#: ../output-renderers/latex-renderer.c:373
+msgid "Could not open LaTeX output file"
+msgstr ""
+
+#: ../command-line.c:195
+#, c-format
+msgid "Couldn't find cell in first library!\n"
+msgstr ""
+
+#: ../command-line.c:81
+#, c-format
+msgid "Count of renderers %d does not match count of output file names %d\n"
+msgstr ""
+
+#: ../main.c:286
+msgid "Create PDF Layers (OCG)"
+msgstr ""
+
+#: ../main.c:285
+msgid "Create standalone TeX"
+msgstr ""
+
+#: ../main.c:280
+msgid "Divide output coordinates by <SCALE>"
+msgstr ""
+
+#: ../resources/layer-widget.glade:62
+msgid "Export Layer"
+msgstr ""
+
+#: ../output-renderers/cairo-renderer.c:366
+#, c-format
+msgid "Exporting layer %d to file\n"
+msgstr ""
+
+#: ../output-renderers/external-renderer.c:142
+msgid "External renderer finished."
+msgstr ""
+
+#. This should not happen
+#: ../output-renderers/cairo-renderer.c:271
+#, c-format
+msgid "Fatal error: Cairo Renderer: Could not spawn child process!"
+msgstr ""
+
+#: ../resources/main.glade:50
+msgid "GDS-Render"
+msgstr ""
+
+#: ../gds-render-gui.c:294
+msgid "GDSII-Files"
+msgstr ""
+
+#: ../resources/dialog.glade:18
+msgid "Generate LaTeX/TikZ output"
+msgstr ""
+
+#: ../resources/dialog.glade:93
+msgid "Generate PDF Layers"
+msgstr ""
+
+#: ../output-renderers/latex-renderer.c:253
+#, c-format
+msgid "Generating cell %s"
+msgstr ""
+
+#: ../resources/about.glade:12
+msgid "Git Repository"
+msgstr ""
+
+#: ../widgets/conv-settings-dialog.c:246
+#, c-format
+msgid "Height: %.3lf %sm"
+msgstr ""
+
+#: ../main.c:321
+#, c-format
+msgid "Ignored argument: %s"
+msgstr ""
+
+#: ../output-renderers/external-renderer.c:106
+#, c-format
+msgid ""
+"Init function not found in library:\n"
+"%s\n"
+msgstr ""
+
+#: ../output-renderers/cairo-renderer.c:321
+#, c-format
+msgid "Layer number too high / outside of spec.\n"
+msgstr ""
+
+#: ../output-renderers/cairo-renderer.c:369
+#, c-format
+msgid "Layer outside of spec.\n"
+msgstr ""
+
+#: ../widgets/layer-element.c:102
+#, c-format
+msgid "Layer: %d"
+msgstr ""
+
+#: ../gds-render-gui.c:241
+msgid "Library"
+msgstr ""
+
+#: ../resources/main.glade:68
+msgid "Load Mapping"
+msgstr ""
+
+#: ../resources/main.glade:73
+msgid "Load the current layer configuration from CSV"
+msgstr ""
+
+#: ../main.c:116
+#, c-format
+msgid "Logo could not be displayed: %s\n"
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:293
+msgid "No layer specification supplied."
+msgstr ""
+
+#: ../command-line.c:186
+#, c-format
+msgid "No library in library list. This should not happen.\n"
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:288
+msgid "No/invalid output file set."
+msgstr ""
+
+#: ../widgets/conv-settings-dialog.c:291
+msgid "OK"
+msgstr ""
+
+#: ../resources/main.glade:58
+msgid "Open GDS2 Database"
+msgstr ""
+
+#: ../gds-render-gui.c:287
+msgid "Open GDSII"
+msgstr ""
+
+#: ../gds-render-gui.c:284
+msgid "Open GDSII File"
+msgstr ""
+
+#: ../main.c:299
+#, c-format
+msgid "Option parsing failed: %s\n"
+msgstr ""
+
+#: ../widgets/conv-settings-dialog.c:255
+#, c-format
+msgid "Output Height: %u px"
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:283
+msgid "Output Renderer not valid."
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:304
+msgid "Output Renderer: Rendering function broken. This is a bug."
+msgstr ""
+
+#. Set the pixel sizes
+#: ../widgets/conv-settings-dialog.c:252
+#, c-format
+msgid "Output Width: %u px"
+msgstr ""
+
+#: ../main.c:282
+msgid "Output file path. Can be used multiple times."
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:298
+msgid "Output renderer called without cell to render."
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:74
+msgid "Output renderer does not define a render_output function!"
+msgstr ""
+
+#: ../main.c:283
+msgid "Path for Layer Mapping File"
+msgstr ""
+
+#: ../main.c:288
+msgid ""
+"Path to a custom shared object, that implements the necessary rendering "
+"functions"
+msgstr ""
+
+#: ../output-renderers/external-renderer.c:78
+#, c-format
+msgid "Path to shared object not set!\n"
+msgstr ""
+
+#: ../command-line.c:74
+#, c-format
+msgid "Please specify renderers and file names\n"
+msgstr ""
+
+#: ../command-line.c:104
+#, c-format
+msgid ""
+"Please specify shared object for external renderer. Will ignore this "
+"renderer.\n"
+msgstr ""
+
+#: ../main.c:277
+msgid "Print version"
+msgstr ""
+
+#: ../command-line.c:160
+#, c-format
+msgid "Probably missing argument. Check --help option\n"
+msgstr ""
+
+#: ../main.c:219
+msgid "Quit"
+msgstr ""
+
+#: ../widgets/activity-bar.c:104
+msgid "Ready"
+msgstr ""
+
+#: ../resources/dialog.glade:33
+msgid "Render PDF using Cairographics"
+msgstr ""
+
+#: ../resources/dialog.glade:48
+msgid "Render SVG using Cairographics (too buggy at the moment)"
+msgstr ""
+
+#: ../widgets/conv-settings-dialog.c:293
+msgid "Renderer Settings"
+msgstr ""
+
+#: ../output-renderers/gds-output-renderer.c:365
+msgid "Renderer already started asynchronously"
+msgstr ""
+
+#: ../main.c:279
+msgid "Renderer to use. Can be used multiple times."
+msgstr ""
+
+#: ../output-renderers/cairo-renderer.c:467
+msgid "Rendering Cairo Output..."
+msgstr ""
+
+#: ../gds-render-gui.c:554
+msgid "Rendering cell..."
+msgstr ""
+
+#: ../output-renderers/external-renderer.c:98
+#, c-format
+msgid ""
+"Rendering function not found in library:\n"
+"%s\n"
+msgstr ""
+
+#: ../resources/main.glade:86
+msgid "Save Mapping"
+msgstr ""
+
+#: ../resources/main.glade:23
+msgid "Save the current layer configuration to CSV"
+msgstr ""
+
+#: ../main.c:312
+#, c-format
+msgid "Scale < 1 not allowed. Setting to 1\n"
+msgstr ""
+
+#: ../resources/layer-widget.glade:51
+msgid "Select Layer Color and Opacity"
+msgstr ""
+
+#: ../resources/main.glade:240
+msgid "Select all layers for export"
+msgstr ""
+
+#: ../output-renderers/cairo-renderer.c:331
+#, c-format
+msgid "Size of layer %d%s%s%s: <%lf x %lf> @ (%lf | %lf)\n"
+msgstr ""
+
+#: ../resources/main.glade:195
+msgid "Sort layers ascending"
+msgstr ""
+
+#: ../resources/main.glade:210
+msgid "Sort layers descending"
+msgstr ""
+
+#: ../main.c:212
+#, c-format
+msgid ""
+"There is already an open instance. Will open second window in that "
+"instance.\n"
+msgstr ""
+
+#: ../main.c:244
+#, c-format
+msgid ""
+"This is gds-render, version: %s\n"
+"\n"
+"For a list of supported commands execute with --help option.\n"
+msgstr ""
+
+#: ../gds-utils/gds-tree-checker.c:188
+#, c-format
+msgid "Visited cell list should be empty. This is a bug. Please report this.\n"
+msgstr ""
+
+#: ../widgets/conv-settings-dialog.c:244
+#, c-format
+msgid "Width: %.3lf %sm"
+msgstr ""
+
+#: ../widgets/activity-bar.c:110
+msgid "Working..."
+msgstr ""
+
+#: ../main.c:96
+msgid ""
+"gds-render is a free tool for rendering GDS2 layout files into vector "
+"graphics."
+msgstr ""
+
+#: ../resources/layer-widget.glade:37
+msgid "label"
+msgstr ""