Compare commits

...

6 Commits

46 changed files with 272 additions and 122 deletions

View File

@ -10,18 +10,18 @@ add_subdirectory(glade)
add_subdirectory(doxygen)
add_subdirectory(version)
include_directories(${GLIB_INCLUDE_DIRS} ${GTK3_INCLUDE_DIRS} ${CAIRO_INCLUDE_DIRS})
include_directories(${GLIB_INCLUDE_DIRS} ${GTK3_INCLUDE_DIRS} ${CAIRO_INCLUDE_DIRS} ${CMAKE_CURRENT_SOURCE_DIR}/include)
link_directories(${GLIB_LINK_DIRS} ${GTK3_LINK_DIRS} ${CAIRO_LINK_DIRS})
add_definitions(${GLIB2_CFLAGS_OTHER})
aux_source_directory("widgets" LAYER_SOURCES)
aux_source_directory("tree-renderer" RENDERER_SOURCES)
aux_source_directory("gds-utils" GDS_SOURCES)
aux_source_directory("latex-output" LATEX_SOURCES)
aux_source_directory("cairo-output" CAIRO_SOURCES)
aux_source_directory("trigonometric" TRIG_SOURCES)
aux_source_directory("latex-renderer" LATEX_SOURCES)
aux_source_directory("cairo-renderer" CAIRO_SOURCES)
aux_source_directory("geometric" GEOMETRIC_SOURCES)
aux_source_directory("layer" LAYER_SELECTOR_SOURCES)
set(SOURCE "main.c" "mapping-parser.c" "command-line.c" "gds-render-gui.c" "external-renderer.c")
set(SOURCE "main.c" "command-line.c" "gds-render-gui.c" "external-renderer.c")
set(SOURCE
${SOURCE}
@ -30,7 +30,7 @@ set(SOURCE
${GDS_SOURCES}
${LATEX_SOURCES}
${CAIRO_SOURCES}
${TRIG_SOURCES}
${GEOMETRIC_SOURCES}
${LAYER_SELECTOR_SOURCES}
)

View File

@ -1,4 +1,4 @@
# GDS-Render
# GDS-Render Readme
This software is a rendering programm for GDS2 layout files.
The GDS2 format is mainly used in integrated circuit development.

View File

@ -26,13 +26,14 @@
* @{
*/
#include "cairo-output.h"
#include <math.h>
#include <stdlib.h>
#include <cairo.h>
#include <cairo-pdf.h>
#include <cairo-svg.h>
#include <gds-render/cairo-renderer/cairo-output.h>
/**
* @brief The cairo_layer struct
* Each rendered layer is represented by this struct.

View File

@ -29,14 +29,15 @@
*/
#include <stdio.h>
#include "command-line.h"
#include "gds-utils/gds-parser.h"
#include "mapping-parser.h"
#include "layer/layer-info.h"
#include "cairo-output/cairo-output.h"
#include "latex-output/latex-output.h"
#include "external-renderer.h"
#include "gds-utils/gds-tree-checker.h"
#include <gds-render/command-line.h>
#include <gds-render/gds-utils/gds-parser.h>
#include <gds-render/layer/mapping-parser.h>
#include <gds-render/layer/layer-info.h>
#include <gds-render/cairo-renderer/cairo-output.h>
#include <gds-render/latex-renderer/latex-output.h>
#include <gds-render/external-renderer.h>
#include <gds-render/gds-utils/gds-tree-checker.h>
/**
* @brief Delete layer_info and free nem element.

67
doxygen/compilation.dox Normal file
View File

@ -0,0 +1,67 @@
/**
@page compilation Compilation
@section Preface
GDS-Render is designed for UNIX-like, especially GNU/Linux based systems.
It was developed under a Linux system. Therefore, best performance is expected using a Linux operating system.
@section depencencies Dependencies
The dependencies of GDS-Render are:
@subsection run-deps Program Dependencies
- GLib2
- GTK3
- Cairographics
@subsection comp-deps Compilation Dependencies
These dependencies are not needed for running the program; just for compilation.
- Build System (GCC + binutils, make, etc...). Most distributions supply a "development" meta-package containing this stuff.
- cmake >= 2.8
- More or less optional: git. Used for extraction of the precise version number. It is strongly recommended to provide git!
- Optional: doxygen for this nice documentation.
The dependency list of GTK3 already includes Cairographics and GLib2. You should be on the safe side with a recent GTK3 version.
Development is done with the following library versions:
| Cairographics | GLib2 | GTK3 |
| ------------- | ---------- | ------ |
| 1.16.0-2 | 2.60.0-1 | 3.24.7 |
@section comp-instr Compilation Instructions
@subsection linux-build General Linux Build Instruction
Go to the build directory you want to compile in. This may be the gds-render project root.
Execute
@code
cmake <Path to gds-render root>
@endcode
Cmake will check the dependencies. Once cmake has finished. Type
@code
make
@endcode
in order to build the program and
@code
make documentation
@endcode
to build the doxygen documentation.
@subsection arch-makepkg Archlinux Package
The subfolder 'AUR' contains a PKGBUILD file to build an Archlinux/Pacman package.
@subsection Compiler Warnings
The compiler will throw the following warnings. Compiled with GCC 8.2.1.
| Warning | Assessment |
| ------- | ---------- |
| warning: calculate_path_miter_points defined but not used [-Wunused-function] | Ignore. Function will be used in later versions. |
*/

View File

@ -1,8 +1,8 @@
/* This file only contains help information for doxygen */
/**
* @defgroup trigonometric Trigonometric Helper Functions
* @defgroup geometric Geometric Helper Functions
*
* The trigonometric helper function are used to calculate bounding boxes
* The geometric helper function are used to calculate bounding boxes
* @warning Code is incomplete. Please double check for functionality!
*/

6
doxygen/gui.dox Normal file
View File

@ -0,0 +1,6 @@
/* This file only contains help information for doxygen */
/**
* @defgroup GUI Graphical User Interface
* @ingroup MainApplication
*/

View File

@ -6,7 +6,7 @@ This programm converts GDS layout files to
- PDF Files using the @ref Cairo-Renderer
- Latex code (TikZ) using the @ref LaTeX-Renderer
See the @subpage usage page for details
See the @subpage usage page for details and @subpage compilation for building instructions.

View File

@ -2,5 +2,5 @@
/**
* @defgroup Widgets Custom GTK Widgets
*
* @ingroup GUI
*/

View File

@ -28,10 +28,11 @@
* @{
*/
#include "external-renderer.h"
#include <dlfcn.h>
#include <stdio.h>
#include <gds-render/external-renderer.h>
int external_renderer_render_cell(struct gds_cell *toplevel_cell, GList *layer_info_list,
char *output_file, char *so_path)
{

View File

@ -27,19 +27,20 @@
* @{
*/
#include "gds-render-gui.h"
#include <stdio.h>
#include "gds-utils/gds-parser.h"
#include <gtk/gtk.h>
#include "layer/layer-selector.h"
#include "tree-renderer/tree-store.h"
#include "latex-output/latex-output.h"
#include "widgets/conv-settings-dialog.h"
#include "cairo-output/cairo-output.h"
#include "trigonometric/cell-trigonometrics.h"
#include "version/version.h"
#include "tree-renderer/lib-cell-renderer.h"
#include "gds-utils/gds-tree-checker.h"
#include <gds-render/gds-render-gui.h>
#include <gds-render/gds-utils/gds-parser.h>
#include <gds-render/gds-utils/gds-tree-checker.h>
#include <gds-render/layer/layer-selector.h>
#include <gds-render/tree-renderer/tree-store.h>
#include <gds-render/tree-renderer/lib-cell-renderer.h>
#include <gds-render/latex-renderer/latex-output.h>
#include <gds-render/cairo-renderer/cairo-output.h>
#include <gds-render/widgets/conv-settings-dialog.h>
#include <gds-render/geometric/cell-geometrics.h>
#include <gds-render/version.h>
enum gds_render_gui_signal_sig_ids {SIGNAL_WINDOW_CLOSED = 0, SIGNAL_COUNT};

View File

@ -34,8 +34,6 @@
* @{
*/
#include "gds-parser.h"
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
@ -43,6 +41,8 @@
#include <math.h>
#include <cairo.h>
#include <gds-render/gds-utils/gds-parser.h>
/**
* @brief Default units assumed for library.
* @note This value is usually overwritten with the value defined in the library.

View File

@ -33,9 +33,10 @@
* @{
*/
#include "gds-tree-checker.h"
#include <stdio.h>
#include <gds-render/gds-utils/gds-tree-checker.h>
int gds_tree_check_cell_references(struct gds_library *lib)
{
GList *cell_iter;

View File

@ -24,14 +24,15 @@
*/
/**
* @addtogroup trigonometric
* @addtogroup geometric
* @{
*/
#include <stdio.h>
#include "bounding-box.h"
#include <math.h>
#include <gds-render/geometric/bounding-box.h>
#define MIN(a,b) (((a) < (b)) ? (a) : (b)) /**< @brief Return smaller number */
#define MAX(a,b) (((a) > (b)) ? (a) : (b)) /**< @brief Return bigger number */
#define ABS_DBL(a) ((a) < 0 ? -(a) : (a))

View File

@ -18,16 +18,17 @@
*/
/**
* @file cell-trigonometrics.c
* @file cell-geometrics.c
* @brief Calculation of gds_cell trigonometrics
* @author Mario Hüttel <mario.huettel@gmx.net>
*/
#include "cell-trigonometrics.h"
#include <math.h>
#include <gds-render/geometric/cell-geometrics.h>
/**
* @addtogroup trigonometric
* @addtogroup geometric
* @{
*/

View File

@ -24,14 +24,15 @@
*/
/**
* @addtogroup trigonometric
* @addtogroup geometric
* @{
*/
#include "vector-operations.h"
#include <math.h>
#include <stdlib.h>
#include <gds-render/geometric/vector-operations.h>
#define ABS_DBL(a) ((a) < 0 ? -(a) : (a))
double vector_2d_scalar_multipy(struct vector_2d *a, struct vector_2d *b)

View File

@ -21,11 +21,11 @@
* @brief Header File for Cairo output renderer
* @author Mario Hüttel <mario.huettel@gmx.net>
*/
#ifndef __CAIRO_OUTPUT_H__
#define __CAIRO_OUTPUT_H__
#ifndef _CAIRO_OUTPUT_H_
#define _CAIRO_OUTPUT_H_
#include "../layer/layer-info.h"
#include "../gds-utils/gds-types.h"
#include <gds-render/gds-utils/gds-types.h>
#include <gds-render/layer/layer-info.h>
/** @addtogroup Cairo-Renderer
* @{
@ -45,4 +45,4 @@ void cairo_render_cell_to_vector_file(struct gds_cell *cell, GList *layer_infos,
/** @} */
#endif /* __CAIRO_OUTPUT_H__ */
#endif /* _CAIRO_OUTPUT_H_ */

View File

@ -30,6 +30,7 @@
#ifndef _COMMAND_LINE_H_
#define _COMMAND_LINE_H_
#include <glib.h>
/**
@ -48,6 +49,8 @@
* @param so_name Path to shared object of custom renderer
* @param so_out_file Output file path for custom renderer
* @param svg_name SVG file name
*
* @note This function is pretty damn retarded (Lots of parameters). Will be reworked when generating GObjects for renderers.
*/
void command_line_convert_gds(char *gds_name, char *pdf_name, char *tex_name, gboolean pdf, gboolean tex,
char *layer_file, char *cell_name, double scale, gboolean pdf_layers,

View File

@ -31,7 +31,7 @@
#ifndef _EXTERNAL_RENDERER_H_
#define _EXTERNAL_RENDERER_H_
#include "gds-utils/gds-types.h"
#include <gds-render/gds-utils/gds-types.h>
#include <glib.h>
/**

View File

@ -28,11 +28,12 @@
* @{
*/
#ifndef __GDSPARSE_H__
#define __GDSPARSE_H__
#ifndef _GDSPARSER_H_
#define _GDSPARSER_H_
#include <glib.h>
#include "gds-types.h"
#include <gds-render/gds-utils/gds-types.h>
#define GDS_PRINT_DEBUG_INFOS (0) /**< @brief 1: Print infos, 0: Don't print */
@ -46,4 +47,4 @@ int clear_lib_list(GList **library_list);
/** @} */
#endif /* __GDSPARSE_H__ */
#endif /* _GDSPARSE_H_ */

View File

@ -31,7 +31,7 @@
#ifndef _GDS_TREE_CHECKER_H_
#define _GDS_TREE_CHECKER_H_
#include "gds-types.h"
#include <gds-render/gds-utils/gds-types.h>
/**
* @brief gds_tree_check_cell_references checks if all child cell references can be resolved in the given library

View File

@ -24,14 +24,15 @@
*/
/**
* @addtogroup trigonometric
* @addtogroup geometric
* @{
*/
#ifndef _BOUNDING_BOX_H_
#define _BOUNDING_BOX_H_
#include <glib.h>
#include "vector-operations.h"
#include <gds-render/geometric/vector-operations.h>
#include <stdbool.h>
union bounding_box {

View File

@ -18,30 +18,30 @@
*/
/**
* @file cell-trigonometrics.h
* @brief Calculation of gds_cell trigonometrics
* @file cell-geometrics.h
* @brief Calculation of gds_cell geometrics
* @author Mario Hüttel <mario.huettel@gmx.net>
*/
/**
* @addtogroup trigonometric
* @addtogroup geometric
* @{
*/
#ifndef _CELL_TRIGONOMETRICS_H_
#define _CELL_TRIGONOMETRICS_H_
#ifndef _CELL_GEOMETRICS_H_
#define _CELL_GEOMETRICS_H_
#include "bounding-box.h"
#include "../gds-utils/gds-types.h"
#include <gds-render/geometric/bounding-box.h>
#include <gds-render/gds-utils/gds-types.h>
/**
* @brief calculate_cell_bounding_box Calculate bounding box of gds cell
* @param box Resulting boundig box. Will be uüdated and not overwritten
* @param cell toplevel cell
* @warning Path handling not yet implemented correctly
* @param cell Toplevel cell
* @warning Path handling not yet implemented correctly.
*/
void calculate_cell_bounding_box(union bounding_box *box, struct gds_cell *cell);
#endif /* _CELL_TRIGONOMETRICS_H_ */
#endif /* _CELL_GEOMETRICS_H_ */
/** @} */

View File

@ -24,7 +24,7 @@
*/
/**
* @addtogroup trigonometric
* @addtogroup geometric
* @{
*/

View File

@ -31,10 +31,11 @@
* @{
*/
#include "../gds-utils/gds-types.h"
#include <glib.h>
#include <stdio.h>
#include "../layer/layer-info.h"
#include "gds-render/layer/layer-info.h"
#include <gds-render/gds-utils/gds-types.h>
#define LATEX_LINE_BUFFER_KB (10) /**< @brief Buffer for LaTeX Code line in KiB */

View File

@ -0,0 +1,51 @@
/*
* GDSII-Converter
* Copyright (C) 2019 Mario Hüttel <mario.huettel@gmx.net>
*
* This file is part of GDSII-Converter.
*
* GDSII-Converter is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* GDSII-Converter is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GDSII-Converter. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file layer-info.c
* @brief Helper functions and definition of layer info struct
* @author Mario Hüttel <mario.huettel@gmx.net>
*/
#ifndef _LAYER_INFO_H_
#define _LAYER_INFO_H_
#include <gtk/gtk.h>
/**
* @brief Layer information.
*
* This structs contains information on how to render a layer
*/
struct layer_info
{
int layer; /**< @brief Layer number */
char *name; /**< @brief Layer name */
int stacked_position; ///< @brief Position of layer in output @warning This parameter is not used by any renderer so far @note Lower is bottom, higher is top
GdkRGBA color; /**< @brief RGBA color used to render this layer */
};
/**
* @brief Delete a layer_info struct
* @param info Struct to be deleted.
* @note The layer_info::name Element has to be freed manually
*/
void layer_info_delete_struct(struct layer_info *info);
#endif // _LAYER_INFO_H_

View File

@ -31,8 +31,9 @@
* @{
*/
#include <gtk/gtk.h>
#include "widgets/layer-element.h"
#include <glib.h>
#include <gds-render/widgets/layer-element.h>
/**
* @brief Load a line from \p stream and parse try to parse it as layer information

View File

@ -24,7 +24,8 @@
*/
/**
* @addtogroup Widgets
* @addtogroup RendererSettingsDialog
* @ingroup Widgets
* @{
*/

View File

@ -24,7 +24,8 @@
*/
/**
* @addtogroup Widgets
* @addtogroup LayerElement
* @ingroup Widgets
* @{
*/

View File

@ -23,9 +23,10 @@
* @author Mario Hüttel <mario.huettel@gmx.net>
*/
#include "latex-output.h"
#include <math.h>
#include <gds-render/latex-renderer/latex-output.h>
/**
* @addtogroup LaTeX-Renderer
* @{

View File

@ -1,9 +1,39 @@
/*
* GDSII-Converter
* Copyright (C) 2019 Mario Hüttel <mario.huettel@gmx.net>
*
* This file is part of GDSII-Converter.
*
* GDSII-Converter is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* GDSII-Converter is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GDSII-Converter. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file layer-info.c
* @brief Helper functions for layer info struct
* @author Mario Hüttel <mario.huettel@gmx.net>
*/
#include "layer-info.h"
/**
* @addtogroup MainApplication
* @{
*/
#include <gds-render/layer/layer-info.h>
void layer_info_delete_struct(struct layer_info *info)
{
if (info)
free(info);
}
/** @} */

View File

@ -1,26 +0,0 @@
#ifndef _LAYER_INFO_H_
#define _LAYER_INFO_H_
#include <gtk/gtk.h>
/**
* @brief Layer information.
*
* This structs contains information on how to render a layer
*/
struct layer_info
{
int layer; /**< @brief Layer number */
char *name; /**< @brief Layer name */
int stacked_position; ///< @brief Position of layer in output @warning This parameter is not used by any renderer so far @note Lower is bottom, higher is top
GdkRGBA color; /**< @brief RGBA color used to render this layer */
};
/**
* @brief Delete a layer_info struct
* @param info Struct to be deleted.
* @note The layer_info::name Element has to be freed manually
*/
void layer_info_delete_struct(struct layer_info *info);
#endif // _LAYER_INFO_H_

View File

@ -28,16 +28,17 @@
* @{
*/
#include "layer-selector.h"
#include "layer-info.h"
#include "../gds-utils/gds-parser.h"
#include "../widgets/layer-element.h"
#include "../mapping-parser.h"
#include <glib.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <gds-render/layer/layer-selector.h>
#include <gds-render/layer/layer-info.h>
#include <gds-render/gds-utils/gds-parser.h>
#include <gds-render/widgets/layer-element.h>
#include <gds-render/layer/mapping-parser.h>
struct _LayerSelector {
/* Parent */
GObject parent;
@ -55,7 +56,6 @@ struct _LayerSelector {
G_DEFINE_TYPE(LayerSelector, layer_selector, G_TYPE_OBJECT)
/* Drag and drop code
* Original code from https://blog.gtk.org/2017/06/01/drag-and-drop-in-lists-revisited/
*/

View File

@ -29,7 +29,7 @@
* @{
*/
#include "mapping-parser.h"
#include <gds-render/layer/mapping-parser.h>
int mapping_parser_load_line(GDataInputStream *stream, gboolean *export, char **name, int *layer, GdkRGBA *color)
{

13
main.c
View File

@ -20,10 +20,11 @@
#include <stdio.h>
#include <gtk/gtk.h>
#include <glib.h>
#include "gds-render-gui.h"
#include "command-line.h"
#include "external-renderer.h"
#include "version/version.h"
#include <gds-render/gds-render-gui.h>
#include <gds-render/command-line.h>
#include <gds-render/external-renderer.h>
#include <gds-render/version.h>
struct application_data {
GtkApplication *app;
@ -119,7 +120,9 @@ static int start_gui(int argc, char **argv)
GtkApplication *gapp;
int app_status;
static struct application_data appdata = {.gui_list = NULL};
static struct application_data appdata = {
.gui_list = NULL
};
GMenu *menu;
GMenu *m_quit;
GMenu *m_about;

View File

@ -17,8 +17,8 @@
* along with GDSII-Converter. If not, see <http://www.gnu.org/licenses/>.
*/
#include "lib-cell-renderer.h"
#include "../gds-utils/gds-types.h"
#include <gds-render/tree-renderer/lib-cell-renderer.h>
#include <gds-render/gds-utils/gds-types.h>
G_DEFINE_TYPE(LibCellRenderer, lib_cell_renderer, GTK_TYPE_CELL_RENDERER_TEXT)

View File

@ -28,9 +28,9 @@
* @{
*/
#include "tree-store.h"
#include "lib-cell-renderer.h"
#include "../gds-utils/gds-types.h"
#include <gds-render/tree-renderer/tree-store.h>
#include <gds-render/tree-renderer/lib-cell-renderer.h>
#include <gds-render/gds-utils/gds-types.h>
/**
* @brief this function olny allows cells to be selected

View File

@ -23,7 +23,6 @@
*/
#ifdef PROJECT_GIT_VERSION
#define xstr(a) str(a)
#define str(a) #a
const char *_app_version_string = xstr(PROJECT_GIT_VERSION);

View File

@ -24,11 +24,12 @@
*/
/**
* @addtogroup Widgets
* @addtogroup RendererSettingsDialog
* @ingroup Widgets
* @{
*/
#include "conv-settings-dialog.h"
#include <gds-render/widgets/conv-settings-dialog.h>
struct _RendererSettingsDialog {
GtkDialog parent;

View File

@ -31,11 +31,12 @@
*/
/**
* @addtogroup Widgets
* @addtogroup LayerElement
* @ingroup Widgets
* @{
*/
#include "layer-element.h"
#include <gds-render/widgets/layer-element.h>
G_DEFINE_TYPE(LayerElement, layer_element, GTK_TYPE_LIST_BOX_ROW)