Inkscape Wiki - User contributions [en]

Using Visual Studio

2015-03-08T14:52:32Z

BitBarrel: Added section to use spaces instead of tabs

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Editor Settings =

The Inkscape coding style is to use spaces instead of tabs. To change this, go to: 
Tools->Options->Text Editor->All Languages->Tabs->Tab: set to "Insert spaces".

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" -j 8
#* '''Note:''' "-j 8" is to compile with 8 cpu threads.
#* '''Note:''' if you only want to build inscape.exe and not inkview or any other tools (to save time), use this as an argument instead:
#* /c "C:\src\inkscape\guides-improvements\btool.exe" -j 8 dist-inkscape
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Compiling will take even longer then a release version of Inkscape.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

== Clean failed ==

If Clean fails with error code -1, make sure you close inkscape first.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool
* Project build->Project rebuild command: btool clean; btool
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T14:40:57Z

BitBarrel: /* Create project in Visual Studio */ Added multi threaded compiling and building inkscape only

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" -j 8
#* '''Note:''' "-j 8" is to compile with 8 cpu threads.
#* '''Note:''' if you only want to build inscape.exe and not inkview or any other tools (to save time), use this as an argument instead:
#* /c "C:\src\inkscape\guides-improvements\btool.exe" -j 8 dist-inkscape
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Compiling will take even longer then a release version of Inkscape.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

== Clean failed ==

If Clean fails with error code -1, make sure you close inkscape first.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool
* Project build->Project rebuild command: btool clean; btool
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T04:27:53Z

BitBarrel: /* Make error */ formatting

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Compiling will take even longer then a release version of Inkscape.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

== Clean failed ==

If Clean fails with error code -1, make sure you close inkscape first.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool
* Project build->Project rebuild command: btool clean; btool
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T04:16:44Z

BitBarrel: /* WinGDB settings */

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Compiling will take even longer then a release version of Inkscape.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

== Clean failed ==

If Clean fails with error code -1, make sure you close inkscape first.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool
* Project build->Project rebuild command: btool clean; btool
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T04:13:48Z

BitBarrel: /* Building Inkscape */ rephrase

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Compiling will take even longer then a release version of Inkscape.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

== Clean failed ==

If Clean fails with error code -1, make sure you close inkscape first.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T04:11:36Z

BitBarrel: /* Trouble shooting */

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

== Clean failed ==

If Clean fails with error code -1, make sure you close inkscape first.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T04:07:51Z

BitBarrel: /* Create project in Visual Studio */

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
#* '''Note:''' Do not set this directory to \src
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#* '''Note:''' The field "Working directory relative to the build directory" is automatically set to "inkscape". This is correct.
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T03:32:43Z

BitBarrel: /* Build failed */ rewording

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Delete the project and make a new project using the wizard, paying attention to the correct paths.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T03:26:24Z

BitBarrel: /* Trouble shooting */

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

== Build failed ==

If you get the error below, the main build directory is incorrect. Go to: Project->VisualGDB Project Properties->Build Settings->Main Build Directory, and change to the directory where btool is located. If that doesn't work, delete the project and make a new project using the wizard.

Error 1 error : Command-line action failed
Error 2 error : Build has failed. See the Output window for more details.
Error 3 error MSB3073: The command ""C:\VisualGDB\\VisualGDB.exe" /build exited with code 1.

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T02:58:03Z

BitBarrel: /* Create project in Visual Studio */ formatting

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way. 
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-07T02:57:03Z

BitBarrel: /* Create project in Visual Studio */ Added project properties location

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way.
'''Note:''' The project settings can be changed at a later time by going to: Project->VisualGDB Project Properties.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

File:Diagnose-breakpoint.png

2015-03-07T02:52:41Z

BitBarrel: uploaded a new version of "File:Diagnose-breakpoint.png": Cropped

Using Visual Studio

2015-03-07T02:48:45Z

BitBarrel: /* Trouble shooting */ Added make error sections

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

== Unable to break ==

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

== Make error ==

If you get the error below, it means the environment variables are not set up correctly. Do not use mingwenv.bat to set up the environment variables, but set them in the Windows System Settings instead as described here: [[Compiling Inkscape on Windows#Set_Environmental_Variables|Setting Environment Variables]]

Error:
--- i18n / msgfmt
Make error line 422: executeCommand : could not create process : the system cannot find the file specified.
Make error line 422: <msgfmt> problem:

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Inkscape

2015-03-07T02:38:33Z

BitBarrel: /* First Steps */ Added Compiling Inkscape on Windows link

This is a freeform area for Inkscape development and discussion.
Curious about [[WikiSyntax]]?

Other languages: [[Inkscape en español|Wiki en español]], [[L'Inkscape en Català|Wiki en Català]], [[Inkscape em Português|Wiki em Português]], [[Startseite|Wiki auf deutsch]]...

{| cellspacing="11" style="width:100%;"
|-style="vertical-align:top;"
| style="width:33%;background-color: #E6E6E6; padding:.5em;"|
=== Project Info ===
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] - Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] - Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] - Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Contact information]] - the developers' e-mails and SVN nicknames
* [[InkscapeInvariants|Inkscape's Mission]]
* [[CommunicationChannels|Communication Channels]]: how to reach us
* [[AnnouncementToSodipodi|Announcement To Sodipodi]]: this started it all
* [[Branding]]
* [[ContactInfo|Contact Information]]: who's behind Inkscape
* [[Travel Reimbursement Policy]]

|style="width:33%;;background-color: white; padding:.5em;"|

=== User Documentation ===
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] - where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] - what's needed to save in some formats
* [[Effect requirements]] - what's needed to use some effects
* [[Effect reference]] - what each effect does
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] - recovery in case Inkscape crashed
* [[Release notes]]
** '''for version [[Release notes/0.92|0.92]] (active development)'''
** '''for version [[Release notes/0.91|0.91]] (current release)'''
** older versions: [[Release notes/0.48.5|0.48.5]] [[Release notes/0.48.4|0.48.4]] [[Release notes/0.48.3|0.48.3]], [[Release notes/0.48.2|0.48.2]], [[Release notes/0.48.1|0.48.1]], [[Release notes/0.48|0.48]], [[Release notes/0.47|0.47]]
* [[Announcing Releases]]
* [[Tricks and tips]] - miscellaneous advice, may be slightly outdated

|style="width:33%;background-color: #E6E6E6; padding:.5em;"|

=== Help Inkscape Without Coding ===
* [[Bug management]]
* [[Testing]]
* [[Translation information]]
* [[Editing Inkscape's website|Website]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Marketing Scratchpad]]

* [[HelpWanted]]
* [[BugTriageProjects]]
* [[CreatingDists]]: how to build packages
* [[StableBranchUpdates]]
* [[UpdatingTrackerItems]]
* [[TutorialsAndHelp]]
* [[How_To_Start_A_Page]] how to use the wiki
* [[CreatingScreencasts]]
* [[AboutScreenContest]]
|}

{| cellspacing="0" style="width: 100%; background-color: white; border-width:1px; border-style:solid; border-color:#62C012; align:left; padding:11px 0em 0em 11px;"
|- style="vertical-align:top;"
| colspan="2"|

=== Developer Documentation ===
|- style="vertical-align:top;"
| style="width:50%;|
==== First Steps ====
* [[Working with Bazaar]] - How to obtain the source code. A quick start on how to use our version control system
* [[Compiling Inkscape|Compilation]]
* [[Compiling Inkscape on Windows]]
* [[Using Eclipse]] - Debug Inkscape on Windows using Eclipse (outdated)
* [[Using Visual Studio]] - Debug Inkscape on Windows using Microsoft Visual Studio
* [[Developer manual]] - various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] - random tips to help debug problems
* [[Project organization]] - procedures, hierarchy, developer roles and the likes
* [[Janitorial tasks]] - small tasks that need doing
* [[Doxygen documentation]]
* [[Working with SVN]] - besides the code in Bazaar, we still have some things in SVN.

==== Developer tutorials ====
* [[Architectural overview]] - a high-level look at Inkscape
* [[Preferences subsystem]] - creating and using preference values
* XML subsystem (WIP) - how to manipulate the XML representation of a document
* Display subsystem (WIP) - how to make things appear on the canvas
* Tools subsystem (WIP) - how to create a new tool
* [[Creating a new SPObject]]
* Extensions
** [[Extension subsystem]] - an overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]]
** [[Python modules for extensions]] - some helpful routines for use in Python script extensions
* [[Creating Live Path Effects]]
* [[Boost shared pointers]]
* [[Using libsigc++ signals]]
* [[Windows development on Linux]]

==== Miscellaneous ====
* [[INX extension descriptor format]]
* [[Inkscape-specific XML attributes]] - documentation of attributes from Inkscape's XML namespace

* [[Extension repository]]: an Internet central for Inkscape Extensions
* [[Related programs]]

| style="width:50%;|
==== Continuous Integration (Automated testing) ====
* [http://jenkins.inkscape.org Our main testing website (Jenkins)]
* [[How to contribute to automated tests]]
* [[Jenkins server setup]]

==== Development Discussion ====
* [[Roadmap]]: the main todo list
* [[Dependencies]] - what libs are needed to build Inkscape
* [[C++11]] - What C++11 features can be used
* [[NewFeatureProposals]]
* [[ExtensionArchitectureProposals]]
* [[Coding Style|Coding Style Discussion]]
* [[FileTypes]]
* [[ApplicationIcons]] (Application + Interface)
* [[Icons]]
* [[InkscapeColor]]
* [[PrintingSubsystem]]
* [[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] - [[W3C]] full test suite
* [[CSS Support]]
* [[Google Summer Of Code]]
* [[Improved Media Management]]
* [[UI MockupScreenshots]]
* [[Swatch Book]]
* [[Tablet Dialog]]
* [[ViewBoxToDo]] View box support info
* [[Caching]]
* [[UI and Document coordinates‎]]
* [[Mipmapping]]
* [[GtkMMification]]: replace C boilerplate with gtkmm objects

===Lib2Geom===
*[[lib2geom]]
*[[lib2geom Goals]]
*[[lib2geom FAQ]]
*[[lib2geom SVN Repository Guide]]
*[[WorkingWith2GeomFAQ]]: real-life questions answered about using 2Geom in real code
*[[lib2geom py2geom]]: python bindings to 2geom. With this you can use the power of 2geom in python scripts.

|- style="vertical-align:top;"
| style="width:50%;|
==== User Interface Discussion ====
* [[Translation_information]]
* [[AddingInterfaceVerbs]]
* [[AccessibleGraphics]]
* [[ObjectManager]]
* [[DialogsReorganization]]
* [[ModalInterfaces]]
* [[TextUsability]]: text tool /dialog dialog
* [[KeyboardShortcutsToDo]]
** [[KeyboardProfiles]]: how you can help
* [[StatusbarAPI]]
* [[Animation-(Timeline)]]
* [[Free Desktop Graphic Suite]]

| style="width:50%; |
|}

* [[WikiAttic]]: pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:About Inkscape]]
[[Category:User Documentation]]

Compiling Inkscape on Windows 32-bit

2015-03-06T17:29:36Z

BitBarrel: /* See also */ Added Using Visual Studio link

'''For 64 bit: see [[Compiling Inkscape on Windows 64-bit]]'''

----

Inkscape was originally written for Linux, but it has been ported to other platforms, including Windows. Since Windows is not POSIX compliant and doesn't have several features useful to developers (like package management), compiling Inkscape on Windows is more tedious than on Linux, but perfectly possible. To make it easier, we have compiled a package that contains all the libraries you need to build Inkscape. This reduces the effort of compiling Inkscape to: download and install 3 programs, download library package, download sourcecode, and you are ready to go.

==Setting up the build environment==

To develop Inkscape, you will need the following things:

* [http://wiki.bazaar.canonical.com/WindowsDownloads Bazaar]
* [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] programs: puttygen.exe and pageant.exe
* TDM's GCC (MingW): Please use exactly the [http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.1006.0/tdm-gcc-4.6.1.exe/download version 4.6.1 32bit bundle installer] and follow the instructions below. In the setup, '''Uncheck''' the [''Check for updated files on the TDM-GCC server''] when installing, or it will install a newer version. Newer versions (tdm-gcc-4.7+) introduce important changes in gcc and don't work with the current Inkscape devlibs (see [http://old.nabble.com/Compiling-on-Windows-7-x64-td34601489.html developpers' list discussion]).
* Launchpad account

In order to build the installer (not needed for most developers):
* [http://sourceforge.net/projects/nsis/files/NSIS%202/2.46/nsis-2.46-setup.exe/download NSIS 2.46]

===Install the compiler===
Run the TDM-MinGW installer:
# Install in a path that doesn't contain spaces. The path 'C:\mingw' is ideal beacuse it is currently set in the <tt>mingwenv.bat</tt> file (along with the location of devlibs).
#* TDM-MinGW's default install option may be to a different location. You will have to edit the <tt>mingwenv.bat</tt> file to point there.
#* If you install it into another path, set the environment variable MINGW_PATH to the TDM-MinGW installation directory, e.g. the one containing <tt>README-tdm-gcc.txt</tt> (right click My Computer -> Properties -> Advanced -> Environment Variables).
# Be sure to enable the "GCC -> openmp support" checkbox from the components list

===Create your Launchpad account===
You can skip this step (or do it later) if you just want to download the sources, but not submit your changes.

If you do not have an SSH public/private key pair to identify yourself:
*run the program puttygen.exe to generate an SSH key
*save both its parts.
Log into your Launchpad account, go to your profile page and add the public part of the generated key to the list of SSH keys. Run the program pageant.exe (you can add it to Autorun). A tray icon should appear. Right click it, select "Add Key" and pick the private key file you have just generated from the dialog. Note that you need to repeat this after every login whenever you want to access Launchpad.

Now set up Bazaar. First tell it who you are, then associate with your Launchpad account. You need to use the account name (e.g. johnq), not the display name.(John Q. Public).

C:\> bzr whoami "''Your Name'' <''your_real_email@example.com''>"
C:\> bzr launchpad-login ''your_launchpad_account''

===Install the developer libraries===
Check out Inkscape Devlibs into C:\devlibs. If you check them out elsewhere, set the environment variable DEVLIBS_PATH to the path where they are. Devlibs are a bundle of all the libraries needed to compile Inkscape. If you experience any problems, make sure you have an up to date copy of those libraries and an up to date checkout of Inkscape source. To reduce the size of the download, pass the <tt>--lightweight</tt> parameter.

C:\> bzr checkout --lightweight lp:inkscape-devlibs devlibs

To update devlibs:

C:\devlibs> bzr update

All Inkscape developers can commit to the devlibs trunk. Advanced information about Devlibs, mainy useful when you want to update them to newly released versions of upstream libraries, is available here: [[Inkscape Devlibs]].
You can see some infomation from [https://launchpad.net/inkscape-devlibs launchpad:inkscape-devlibs] and [http://bazaar.launchpad.net/~inkscape.dev/inkscape-devlibs/trunk/files trunk/files].

== Obtaining Inkscape source code ==

You can obtain released Inkscape source from a tarball. Since version 0.47 they are hosted on [https://launchpad.net/inkscape Inkscape's Launchpad page]. There are ready-made installers provided, so there's usually little reason to compile the stable version yourself.

To obtain cutting edge code, check out Inkscape source from the Bazaar repository. You can also use the TortoiseBZR shell extensions to do this. The recommended way is to first create a shared repository, then check out the Inkscape branch into that shared repository. Using this setup, branching will be a lot faster.

C:\src\inkscape> bzr init-repo --rich-root .
C:\src\inkscape> bzr upgrade
C:\src\inkscape> bzr checkout lp:inkscape trunk

If you don't want to create any branches, you can skip the shared repository step.

C:\src> bzr checkout lp:inkscape

'''IMPORTANT:''' make sure that the path to your Inkscape source checkout does not contain spaces. Unix tools do not like them and you will end up with a lot of error messages about missing files.

== Set Environmental Variables ==

First set up the environmental variables. You need to run mingwenv once per console session like this:
C:\src\inkscape\trunk> mingwenv
Or you can set the paths in the Windows system settings. Go to (Win 7):

Start->Control Panel ->System and Security->System->Advanced system settings->Advanced->Environment variables->System variables->New.
Add these variable names and values: 
DEVLIBS_PATH c:\devlibs 
MINGW_PATH c:\mingw 
MINGW_BIN c:\mingw\bin 
PKG_CONFIG_PATH c:\devlibs \lib\pkgconfig 
CMAKE_PREFIX_PATH c:\devlibs 
GTKMM_BASEPATH c:\devlibs 

Also, edit the PATH variable, and add these if not already present: 
c:\mingw\bin;c:\devlibs\python;c:\devlibs\bin

After the Environment Variables are set in the Windows system settings, a restart is required.

== Compile the Build Tool ==

Now compile the build tool. (Try the following command one by one. if that command fails)

C:\src\inkscape\trunk> g++ buildtool.cpp -o btool
C:\src\inkscape\trunk> g++ buildtool.cpp -o btool -fopenmp
C:\src\inkscape\trunk> g++ -DNEED_GETTIMEOFDAY buildtool.cpp -o btool -fopenmp

== Building Inkscape ==

Finally initiate the compilation. Get a coffee or take your dog out for a walk, because it will take a rather long time. If you have a multicore processor, add "-j 8" to use (for example) 8 parallel compilation threads.

C:\src\inkscape\trunk> btool -j 8

Once everything is done, there should be an <tt>inkscape</tt> directory that contains the Inkscape executable and libraries needed to run it.

== Rebuilding ==

If you have only changed a few files and want to rebuild, delete the <tt>inkscape</tt> directory and run <tt>btool</tt> again.

To rebuild from scratch, execute the following sequence of commands:
C:\src\inkscape\trunk> btool clean
C:\src\inkscape\trunk> btool

== Dealing With Build Errors ==
Feel free to add any questions or answers you have in here;

'''Q''' - My firewall software (Comodo's Defense+ component or similar) stopped the process continuing to the next step in the build, because I wasn't there to permit an action and it timed out. What can I do?

'''A1''' - The best thing is to disable stuff like Defense+ (put it in learning mode works) because it will stop any process that is not approved, and building makes new files which can't be approved before they're built. Disabling Comodo's Defense+ does not disable your firewall, either inbound or outbound, but just the part that scans every application for suspicious operations. Other firewalls etc may vary.

'''A2''' - If that doesn't suit, often you can simply run btool again and wait for Defense+ (or similar) to ask for approval for the process, and it will then continue as normal with the build. But remember that approving all the processes involved in the build process once doesn't mean they will all slip through next time.

'''A3''' - This is the more complex way to continue, but may help if you have problems with A2. If you know the stage the process was meant to be up to (look at the output in the command windows and compare to the stages in the ''build.xml'' file), you can start again from there.

You may see something like this in the command window;
=============================
## Target : link : link objects and library to create executable
---- task : rc
============ cmd ============
windres -o build/inkres.o --include-dir=src src/inkscape.rc
=============================
---- task : link
This will likely be followed by an error message. This means you were at the ''link'' stage

Now simply type;
...>btool ''stage''
Or in this case
...>btool link
And the build will continue from there.

After this, you will probably have to step through the remaining stages manually, one by one. The stages can include (see build.xml, where each stage is labelled 'target name="''target''"') ''init'', ''touchabout'', ''compile'', ''java'', ''lib'', ''i18n'', ''link'', ''linkinkview'', ''dist'', ''dist-all'', ''clean''.

'''Q''' - How do I rebuild just one ''file.o'' file? For instance if one particular file has gone wrong, or I want to try patching just one part of the code.

'''A''' - To find the right command for building any particular file in Inkscape, just look in the compile.lst after you have used btool once. Search for the name of the particular file (eg: print.cpp) and you will find the command used to compile it. You'll need to paste this into a text file, remove any carriage reurns and then paste that onto the command line.

'''Q''' - After I patched a file, I left a backup of the old file in the same directory called Copy of{filename}.cpp. The compiler complains about this file when building and stops.

'''A''' - Do not leave anything with a suffix .cpp in the source directories, apart from the original (or patched) source files. The build tool will try to compile everything ending in .cpp and will complain. If you backup an old file in the same directory before patching, call it {filename}.cpp.old or similar.

'''Q''' - I think I followed the instruction above. What could have caused the compiling error like this for src/extension/internal/pdfinput/pdf-parser.cpp?

src/extension/internal/pdfinput/pdf-parser.cpp:2248: error: no matching function for call to 'GfxFont::getNextChar(char*&, int&, CharCode*, Unicode [8], int, int*, double*, double*, double*, double*)'

Same error for line 2297 as well.

=== For more information ===
There is some old information on building Inkscape with either Mingw on Windows, or a cross-compiler on Linux, at http://inkscape.modevia.com/win32_inkscape_org/win32buildnotes.html
and old files mey be
http://inkscape.modevia.com/win32libs/
== Creating an installer ==

To create the '''inkscape-$RELEASE-win32.exe''' setup package you need the '''NSIS''' installer on your PC. Get that from http://nsis.sf.net .
You have successfully built Inkscape and everything is in the ...\inkscape\ directory.
Open the ...\packaging\win32\inkscape.nsi using the NSIS program and compile the package. Sooo easy :-)

The new wix installer in the packaging\wix directory creates msi packages. You need the '''windows installer XML''' package; get it from here http://wixtoolset.org/. Follow the instructions in the README file in the packaging\wix directory. The installer scripts parse version information from the inkscape.rc file. The generated packed is named as:

'''inkscape-$RELEASE.msi'''

== Note about Unicode ==

The GTK stack depends on functions only present in NT-based Windows (2000 and later). Therefore, Inkscape code can assume that Unicode functions from the Windows API (like GetCommandLineW) are always present. Note however that you should use the GLib/GTK functions rather the Windows API whenever possible.

=See also=
*[[Compiling Inkscape]]
*[[Using Visual Studio]]

[[Category:Developer Documentation]]

Extension repository

2015-03-05T13:36:53Z

BitBarrel: /* Scale Generator */ Changed link

It would be very useful to have a central Internet repository for Inkscape extensions, in a similar manner to Firefox. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension was updated.

== Extensions ==

===[[ExtrudeEffect]]===
Extrude polygons to "3d", also make "string art".

===[http://wiki.colivre.net/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript]===
Creating calendars sucks or is impractical if you do not have something that automates the process of putting the days organized in blocks of months for you. To format manually is easy, but this extension can help you on this, too. BASH script, works for Win32 with Cygwin.

===[http://wiki.colivre.net/Aurium/InkscapeAreaCuter InkscapeAreaCutter]===
For web designers. Slice your site design into .png images. (pt_BR)

===[http://www.julienvitard.eu/ EQTeXSVG]===
Convert an inline LATEX equation into SVG path using Python.

===[http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX]===
Insert LaTeX text or equations into Inkscape.

===[http://www.iki.fi/pav/software/textext/ TexText]===
Embed re-editable LaTeX objects into SVG drawings.

===[http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform]===
Bend a path according to another one.
N.B. This extension was added to Inkscape 0.45 as "Pattern along Path".

===[http://www.inkbar.lineaire.net/ InkBar]===
Create EAN13 bar codes.

===[http://technoargia.free.fr/swftools/ SWF output]===
Save drawings as SWF. Updated version (compatible with Inkscape 0.48) ist available on [https://gist.github.com/frederik-elwert/1a46f82fce5d3deb7842 GitHub].

===[http://wiki.colivre.net/Aurium/Puff Puff]===
Fluffs elements! :D

===[http://www.colivre.coop.br/Aurium/InkSudoku Sudoku Generator]===
Generates a Sudoku square with its solution (''in a small square if you want'').

===[[CalligraphedOutlineFill]]===
Helps to fill in the inside area of shapes drawn with the Calligraphy tool.

===[http://edlab.die.unipd.it/Site4.html SlotStar]===
Helps to draw the star of slot of a winding of an electrical machine

===[http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension]===
Extract text in an SVG drawing to a LaTeX picture environment.

===[http://saws.googlecode.com s.a.w.s]===
Export an SVG as valid XHTML/CSS files.

===[http://www.colivre.coop.br/Aurium/InkscapeGenerator Generator]===
Replace text and data to automatically generate files (as PDF, PS, JPG, etc...), based on an SVG template and a data file. ''e.g.'', a CSV file

===[http://code.google.com/p/inkscape2tikz/ TikZ exporter]===
Export SVG paths as TikZ/PGF code for use with LaTeX.

===[[FindMatch]]===
Looks for paths that match the selected path and places all matches on the same layer.

===[http://emilien.tlapale.com/code/inksyntax InkSyntax]===
A source code syntax highlighter plugin for Inkscape (wrapping [http://pygments.org pygments] and [http://www.andre-simon.de/doku/highlight/en/highlight.html highlight]).

===[http://sites.google.com/site/placeonpath/ Place Objects on Path]===
Places objects on a curve. The curve is the object that has the lowest z-order (and which must be a path). Distances between objects remain the same as they were before placing. If objects can't be placed on the curve because of their distances they are left in place. Objects will not be modified; clones are allowed. Arrange distances between your objects manually first as curve position and direction.

===[http://code.google.com/p/jessyink/ JessyInk]===
A collection of Javascripts that can be embedded into an SVG file to produce slide shows on opening in a browser. Current releases of JessyInk include a number of inkscape extensions to assign effects, transitions and other aspects of the presentations.

===[http://svg2dxf.googlecode.com/files/svg2dxf_inkscape.zip svg2dxf]===
Updated version of [http://www.bobcookdev.com/inkscape/inkscape-dxf.html Better Better DXF output] which adds support for polylines and does not overwrite the default inkscape simpletransform.py. See README if getting lxml xpath errors.

===[http://code.google.com/p/pixelsnap/ PixelSnap]===
Tool for aligning object/paths onto the pixel grid for bitmap export.

===[http://code.google.com/p/inkscape-guides-creator/ Guide creator]===
Creates multiple guides at once, at set intervals.

===[https://github.com/brathering82/inkscape/tree/master/src Scale Generator]===
Create a scale for a ruler, map, gauge, clock, compass, etc.

===[http://code.google.com/p/scott-inkscape/wiki/SevenSegmentDigits Seven Segment Digits]===
Create calculator style digits.

===[http://www.cnc-club.ru/forum/viewtopic.php?f=15&t=37&p=92 Close curves]===
Closes all open paths in the selection.

===[http://www.cnc-club.ru/forum/viewtopic.php?f=15&p=101 Gcode tools]===
Generates Gcode program (used in CNC machinery) from given paths.

===[http://dp48069596.lolipop.jp/inkscape_script.html Closeoff, Scatterpath, Selection, Zigzag and Netting]===
See [http://dp48069596.lolipop.jp/inkscape_video.html] for how to use Zigzag and scater extensions.

===[http://wiki.xmoto.tuxfamily.org/index.php?title=How_to_create_smooth_levels_using_Inkscape Inksmoto]===
Level editor for the Xmoto game.

===[http://www.cnc-club.ru/forum/viewtopic.php?f=33&t=37 Close Curves]===
Extension to close the paths in the selection, useful for importing filled paths into openoffice.

===[http://kalyaev.com/2010/20100423/gcodetools.html gcodetools]===
Gcodetools is a plug-in for Inkscape. It prepares and converts paths from Inkscape to Gcode, using biarc interpolation. for use with CNC milling machines.

===[http://www.signcutpro.com/SignCut-Productivity-Pro/signcut-export-plugins.html SignCut Export]===
Set of extensions that come with SignCut to enable Inkscape users to use plotters / cutters via the SignCut software.

===[http://www.lysator.liu.se/~perni/iboardgameexts/ Boardgame extensions]===
Inkscape Extensions for Boardgame Developlemt [http://www.boardgamegeek.com/thread/299033/inkscape-extensions-for-boardgame-developlemt 1]. Includes a hexagonal board/hexmap creator and tools to sheets of tiles for counters ect.

===[http://camm-gl.dyndns.org/ Inkscape CAMM-GL Extension]===
... vinyl cutting utility for Inkscape

This program is basically just a cut manager. Create artwork in Inkscape, save with the supplied hpgl_output extension, and cut or plot with this program. The program does provide some useful functions, but it is by no means a fully featured solution. I do use it exclusivly, and it currently satisfies my needs.

===[http://salug.it/~fabioviola/inkscape/extensions Badge Renderer]===
... A little script to render a badge in a Inkscape document.
This is only a little python script used as example in an article for my GLUG (SaLUG!) journal. This can be used to quickly render a badge. It can be improved, for example, with shadow direction and reflex direction. As soon as possible I'll do it.

===[http://www.craigmarshall.org/archives/8 Guillotine]===
This is a mirror of the GIMP guillotine function, it allows you to drag guides onto the canvas, and then using Export->Guillotine, export those slices as pngs to the directory and filename of your choice. It also has an option for using export hints, if your drawing has previously been exported. [http://www.inkscapeforum.com/viewtopic.php?f=11&t=5832 Forum link]

===[http://code.google.com/p/inkscape-replace-font/ Replace Font]===
Allows mass replacement of the fonts in a document. Can list existing fonts. [http://www.inkscapeforum.com/viewtopic.php?f=11&t=5843 Forum link]

=== [http://sozi.baierouge.fr/wiki/doku.php?id=en:welcome Sozi] ===
A tool for presentations made using zooms and rotations, not just slides. Uses Javascript added to the .svg file to display in web-browsers.

Version 13.11 is the last version of sozi which is available as an Inkscape extension. According to [http://sozi.baierouge.fr/release-14.10.html this article], future versions will be available as standalone-application.

===[http://www.inkscapeforum.com/viewtopic.php?f=11&t=5943 CMYK pdf/tiff export]===
Extension to export to CYMK colourspaced PDFs / Tiffs. In development (september 2010)

===[http://sourceforge.net/projects/o-scape/ O-Scape; Orienteering map making tools]===
Extensions to help make Orienteering maps; see this [http://www.nopesport.com/news/1343-o-scape-free-orienteering-mapping-software interview] for more information

===[http://www.inkscapeforum.com/viewtopic.php?f=5&t=4729#p32019 Mirror]===
Mirror a path along any axis.

===[http://sourceforge.net/projects/inkscape-tables/ Tables in Inkscape]===
Adds (experimental?) table suport as an extension.

===[http://doctormo.org/2011/05/19/deviantart-plugins-released/ deviantArt uploaders]===
Upload artwork to deviantArt from the "publish to" menue item under extensions.

===[http://code.google.com/p/inkscape-music-scale-generator/ Musical scales]===
Extension for automatic generation schemes of musical scale and chords on piano.

===[http://www.inkscapeforum.com/viewtopic.php?f=11&t=9212 Text from CSV]===
Extension to enter text from a CSV file

===[http://luther.ceplovi.cz/git/inkscape-ungroup-deep.git/ Deep Ungroup]===
Ungroup all groups in the selected object.

===[http://www.pernsteiner.org/inkscape/layerclip/ Layer Clip]===
This is a a set of Inkscape extension scripts for setting and removing clip paths for entire layers. Inkscape has no trouble rendering or editing layers with clip paths, but it currently has no built-in method of setting the clip path for a layer, this is the purpose of these extensions.

Features include: Clip containing layer, Clip layer above, Clip layer below, Clip parent layer.

'''''Notes:'''
''You must select an object in the clipping layer before applying the extension, otherwise you will receive an error message.
It is a good idea to lock the layer after the extension has been applied. You may also require hiding the clipping layer when using "Clip layer below". This may be exploited to create a masking layer.
Tested on Inkscape 0.48.2 r98''19''

===[https://bitbucket.org/daviddamerell/inkscapesaveasicoextension Icon Generation]===
This is an Inkscape output extension that adds an option to the "save-as" dialog box to generate Windows Icon files (*.ico).

==Extensions for Programmers:==
===[http://wiki.colivre.net/Aurium/RubyInk RubyInk]===
Inkscape extension with Ruby

===[http://wiki.colivre.net/Aurium/InkBash Ink-Bash]===
<nowiki>ShellScript</nowiki> Forever!

===[http://wiki.colivre.net/Aurium/InkMoz InkMoz]===
The Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

== The Repository Specification ==

A website where programmers can publish their extensions, users can search by that, and an update program can access this updates.

=== The Website ===

Must Have:
* '''User Registration''': to allow upload, votes and comments
* '''Extension Validation''': when published, it is public, but the user must be notified that was not validated (the code must be viewed by an validator user). The software updater do not update non-validated versions.
** '''Validation Feedback''': the validator user must write why the extension was not validated.
** '''Extension Deletion''': the validator user can delete an extension or version when he found a malicious code. The upload user must be marked as a malicious user and the account must be blocked.
* '''Extension Search''': with filter, by any available data.
* '''User Votes and Comments for Extensions''': The user can vote and/or comment an extension version.
* '''Extension Bug-Tracker''': today, third part extensions are in simple web-pages. The site may have a Bug-Traker to help all little scripts.
* '''User Extensions Requests''': a lot of users have ideas. Here is a good place for programmers see and make that alive.
* '''Host a cool page for the extension''': allow introduction text, documenbtation, screenshots, examples, and '''i18n'''!
* '''Help the l10n of this extensions''': with a web interface, like pootle and provide the l10n file for the updater program.
* '''Provide Version Control''': A SVN account will be cool, but web uploads (by web-forms) can be transparently SVN commits.

=== The Extension Meta-Data ===

''The data in INX file and more some, like the OS and Inkscape version compatibility...''

The INX file will define the meta-data settable by that. If some extension uses multiples INX files to have more than one option in the menu, all INX files must be read to set the meta-data. The meta-data will be cached in a database to help the search. The DB only need the meta-data of the last validated version and the last non-validated (if that is newer).

=== The Update Program ===

* '''Search for New Extensions''': when the user request
* '''Update Extensions''': search for updates and install that
* '''Help the Code Validation''': for advanced users. Show the extension code and the diff if is that an update.
* '''Help the User Bug-Reporting''': that is not working! The user must say now! ''(When the Update Program be part of the Inkscape, the error window can have a button to submit a bug-report)''
* '''Must test the extension dependencies''': the user must know what is needed to install before try to use.

== Name Proposal ==

Propose a name for the Inkscape Extension Repository:

* '''The Factory'''
* '''Extension Factory'''
* '''INX Factory'''

''Why Factory? Because it is not only a repository. ;-)''

* '''The Furnace'''
''Because Fire & Coal (Passion & Knowledge) are your tools for creating the extensions''

[[Category:Developer Documentation]]
[[Category:Extensions]]

== Mockups ==

Here are some suggestions for what an extension repository might look like.

<gallery>
File:Extension_repository_-_homepage.png|The home page.
File:Extension_repository_-_extension_page.png|The page for an individual extension.
File:Extension_repository_-_request_page.png|The page for an individual request.
File:Extension_repository_-_search_page.png|The search form page.
File:Extension_repository_-_search_results.png|The search results page.
File:Extension_repository_-_submit_extension.png|The extension submission page.
File:Extension_repository_-_submit_request.png|The request submission page.
File:Extension_repository_-_requests.png|The main requests page.
</gallery>

I have no idea of the detail of this project; I don't currently have the skills necessary to try implementing it. I'm also not sure whether it's a good idea for Inkscape to offer hosted repositories (using [http://www.redmine.org/projects/redmine Redmine] or [http://trac.edgewall.org/ Trac]?) or whether it would be better to just leave it to the developer to use somewhere like [http://github.com/ GitHub] or [http://bitbucket.org/ BitBucket] and then use their APIs to pull some basic data onto the site. [[User:Legio noctis|Legio noctis]] 10:19, 23 May 2010 (UTC)

Using Visual Studio

2015-03-05T12:30:15Z

BitBarrel: Added WinGDB section

= Introduction =

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB or WinGDB. These plugins are not free, but fully functional evaluation versions are available. This wiki focuses on the VisualGDB plugin, but WinGDB settings are also provided.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]] 

= WinGDB settings =

Wizard settings:

* File->New->Project->Installed->Templates->WinGDB->WinGDB Standard Projects->Multiplatform Executable->OK
* MinGW installation directory: C:\MinGW
* Make executable location: C:\src\inkscape\trunk\btool.exe
* Source dir: C:\src\inkscape\trunk\src
* Group imported files in folders = true
* Build result directory: C:\src\inkscape\trunk\inkscape
* Build debuggable result: inkscape.exe
* Build working directory: C:\src\inkscape\trunk
* Working directory: C:\src\inkscape\trunk
* Additional source directories: C:\devlibs

Project settings:

* Right click project->WinGDB->Properties->:
* Environment->Debugger path: C:\mingw\bin\gdb.exe
* Environment->Build toolchain paths: C:\MinGW\bin;C:\src\inkscape\trunk
* Debug->Executable path: C:\src\inkscape\trunk\inkscape\inkscape.exe
* Directories->Additional source directories: C:\devlibs
* Project build->Project build command: btool -j 8 (-j 8 is to compile with 8 threads)
* Project build->Project rebuild command: btool clean; btool -j 8
* Project build->Project clean command: btool clean
* Project build->Build working directory: C:\src\inkscape\trunk

Building: 
*WinGDB->Build->Build projectname

Debugging: 
*WinGDB->Start debugging

Using Visual Studio

2015-03-05T11:55:45Z

BitBarrel: /* Stepping through code */

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB. This plugin is not free, but a fully functional evaluation version is available.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop at the breakpoint. Happy debugging.

= Trouble shooting =

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]]

Using Visual Studio

2015-03-05T11:49:18Z

BitBarrel: Added Using Visual Studio page

Microsoft Visual Studio is a popular development tool used primarily with C, C++, and C#. Visual Studio (community edition) can be downloaded for free but it requires a plugin called VisualGDB. This plugin is not free, but a fully functional evaluation version is available.

This page will help you set up Visual Studio for coding, building, and stepping through code in Inkcape.

= Installation =

# Follow all steps of guide [[Compiling Inkscape on Windows]].
# Make sure Inkcape compiles correctly using the console first.
# Install Visual Studio.
# Install VisualGDB.
# Set the Environment variables in the Windows System settings as described here: [[Compiling Inkscape on Windows]]. Do not use mingwenv.bat to set the environment variables.

'''Note:''' It is assumed the required packages are installed in the following directories:
* c:\mingw
* c:\devlibs
* c:\src\inkscape\trunk

= Create project in Visual Studio =

# Open Visual Studio.
# Select File->New->Project->Installed->Templates->VisualGDB->MinGW/Cygwin Project Wizard.
# For the project location, do not use a path with spaces. [[Image:new-project.png]] 
# Give the project a name, and click OK.
# At the wizard, select Project Type->Import a project build with command-line tools. [[Image:import-project.png]] 
# Click Next.
# Check the path to MinGW is correct.
# Click Next.
# Set the Inkscape source directory to:
#* c:\src\inkscape\trunk
# Select Import preserving directory structure. [[Image:import-project-settings.png]] 
# Click Next.
# At Build Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe"
# Select OK.
# At Clean Command, select Customize.
# Set Arguments to:
#* /c "c:\src\inkscape\trunk\btool.exe" clean
# Select OK.
# At Debug Settings->Executable file to debug, browse to:
#* C:\src\inkscape\trunk\inkscape\inkscape.exe [[Image:build-settings.png]] 
#Click Finish and wait for the project generation to finish.

'''Note:''' VisualGDB will not copy the source files to the Visual Studio project directory, so you can still use Version Control the usual way.

= Enable debugging =

In Explorer, open build.xml located in:
* c:\src\inkscape\trunk
Then look for the "T A R G E T : C O M P I L E" section, go to the <flags> section, and change 
-O2
to
-O0

Also add this flag: 
-g

 [[Image:flags.png]] 

Then search for this: 
strip="true" symfile="${build}/inkscape.dbg"
And change to this: 
strip="false" symfile="${build}/inkscape.dbg"

 [[Image:strip.png]] 

'''Note:''' these changes will make Inkscape very slow to compile.

= Building Inkscape =

# In Visual Studio, select Build->Clean Solution.
# Then select Build->Build Solution.
# Come back later. This will take a while.

'''Note:''' The compiler will seem to be stuck at this for a while, but that is normal:
1> --- compile / cc

= Stepping through code =

# In Visual Studio, go to Solution Explorer->Inkscape->Source Files->src->main.cpp, and set a breakpoint here: [[Image:breakpoint.png]] 
# Select Debug->Start Debugging With GDB.
# If you get a "GDB command timeout" window, be patient.
# Inkscape will stop the breakpoint. Happy debugging.

= Trouble shooting =

In case Visual Studio cannot break at a certain breakpoint (most likely no debugging symbols present), you can diagnose breakpoint problems using the VisualGDB diagnose tool:

 [[Image:diagnose-breakpoint.png]]

File:Strip.png

2015-03-05T11:14:03Z

BitBarrel:

File:Import-project.png

2015-03-05T11:13:43Z

BitBarrel:

File:Import-project-settings.png

2015-03-05T11:13:17Z

BitBarrel:

File:Flags.png

2015-03-05T11:12:50Z

BitBarrel:

File:Diagnose-breakpoint.png

2015-03-05T11:12:27Z

BitBarrel:

File:Build-settings.png

2015-03-05T11:12:05Z

BitBarrel:

File:Breakpoint.png

2015-03-05T11:11:41Z

BitBarrel:

File:New-project.png

2015-03-05T11:10:50Z

BitBarrel:

Using Eclipse

2015-03-05T10:31:54Z

BitBarrel: Added reference to Using Visual Studio

{{Needs_update}}

'''Note:''' The instructions in this wiki are out of date and do not work anymore. This page is just a reference as it might provide you with a clue on how to get it to work. If you manage to get compiling and debugging to work under Windows using Eclipse, please modify this page accordingly.

If you are looking for another way of stepping through code on Windows, have a look here: [[Using Visual Studio]].

Eclipse is a popular development tool used primarily with Java; however, C/C++ development can also be done. This page will help you set up Eclipse for coding, building, and debugging Inkscape.

= Eclipse on Fedora =

# Follow the ''Installation'' and ''Configuration'' steps of guide [http://wiki.bazaar.canaonical.com/BzrEclipse BzrEclipse] but be carefull:
#* At this moment, this How to is for a previous version of Eclipse (some dialogs and menus have changed)
#* ''bzr-xmloutput'' must be decompress in a folder named exactly ''xmloutput'' in Bazaar plugins directory

= Setup project in Eclipse =

Following steps are equivalent to:

checkout lp:inkscape /home/{USER_NAME}/workspace/Inkscape

In Eclipse:

# File > New > Project...
# Select Bazaar > Checkout as a new project
# Select ''Initialize a new branch location''
# Set ''Branch location'' to ''lp:inkscape''
# Select ''Create a project''
# Set ''Project name'' to ''Inkscape''

After quite a long time working, the Inkscape project appears in the Eclipse Explorer.

= Eclipse on Windows =

Running Eclipse provides a relatively easy and familiar way to work with Inkscape code on Windows. This section will explain how to make it happen.

'''Note:''' Some of these instructions may be applicable to development on Mac or Linux. Feel free to refactor them if you are adding information for those platforms.

== Initial Setup ==

First, make sure Inkscape compiles under windows using the command line to verify the source and dependencies are installed correctly. Follow the instructions on the [[Win32Port]] page under the heading '''Inkscape under Windows'''.

If you don't have Eclipse, [http://www.eclipse.org/downloads/ get it]. Check out the [http://help.eclipse.org/help32/index.jsp online help] if needed.

Next, you need to set up the necessary add-ons. Most important is the [http://www.eclipse.org/cdt/downloads.php CDT plug-in] which facilitates C/C++ development. You may also wish to add [http://subclipse.tigris.org/install.html Subclipse] for SVN access within Eclipse. Alternatively, many Windows users prefer to use [http://tortoisesvn.net/downloads TortoiseSVN], which works with Windows Explorer.

== Creating a Project ==

=== Subclipse (Outdated as version control is provided by Bazaar now) ===

The next step is to get the source code ready for use in Eclipse. Check [[WorkingWithSVN | here]] for general instructions for working with SVN; in this section, the aim is to show how to check out the code using Subclipse.

In Eclipse, we want the SVN perspective to be open. Click '''Window > Open Perspective > Other'''. Choose '''SVN Repository Exploring''' and click ok.

[[Image:Eclipse-01.png]]

In the '''SVN Repository''' tab, right click and choose '''New > Repository Location...'''.

[[Image:Eclipse-02.png]]

In the '''Location Url:''' box, paste the link https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk and click finish. This location will now show in the '''SVN Repository''' tab. You can expand the tree to see what is on the server.

Now right click the location name (which is really just the link given above), and click '''Checkout...'''. Choose '''Check out as a project configured using the New Project Wizard''' and the revision you want (probably Head), and click '''Finish'''.

In the New Project window that appears, choose '''C++ Project''' in Eclipse Europa (or in Callisto '''Standard Make C++ Project''') and click '''Next'''.

[[Image:Eclipse-Europa-ProjectType.png]]

Give your project a name such as InkscapeSVN. Uncheck the '''Use default location''' box so you can provide a better project location outside of your workspace, such as C:\InkscapeSVN. Select '''Executable (XL C/C++)''' as the project type, and '''XL C/C++ Tool Chain''' as the the Toolchain (this will not be necessary in Callisto (or before?) as this has been already been specified by selecting '''Standard Make C++ Project'''). Click '''Finish'''.

[[Image:Eclipse-Europa-CppProjectType.png]]

The source code will now be checked out - this may take a while. You will also now have a project in the '''C/C++ Perspective''' with whatever name you provided earlier.

=== TortoiseSVN (Outdated as version control is provided by Bazaar now) ===

To use TortoiseSVN instead of Subclipse to check out your project, open a Windows Explorer instance. Right click anywhere outside of an existing SVN tree and choose '''SVN Checkout...'''. Specify the link given above and the destination directory.

To get a project in Eclipse, go to the '''C/C++ Perspective'''.

In Eclipse Europa select '''File > New > C++ Project'''. Choose a project type of '''Executable (XL C/C++)'''.

In Eclipse Calisto right click in the '''C/C++ Projects''' tab, and choose '''New > Project...''' and in the window choose '''Standard Make C++ Project.'''

Give the project a name, and uncheck the '''Use default location''' box. You must give the location that you checked the code out into here.

At this point, you will be able to use TortoiseSVN or Subclipse within Eclipse to control the source.

== Building ==

'''NOTE FOR LINUX USERS''' For building, you can probably get away with running './autogen.sh' then './configure' from the directory containing your copy of the repository. You can then create a 'Builder' which contains Makefile as Main-Location.

Be sure you have the btool built and ready to go, as outlined on the [[Win32Port]] page. You can build Inkscape from the command line or initiate it from within Eclipse, which will capture the output for you.

To set up Eclipse to do this, make sure you are in the '''C/C++ Perspective''' and that your project is open. Right click on the project name and click '''Properties'''. Click on '''Builders'''. Uncheck any builders that are there since we will be using the custom btool. Click '''New...''' and select '''Program'''.

[[Image:Eclipse-04.png]]

In the '''Main''' tab, browse the workspace for the location of the btool.exe file. Browse the workspace again to set the working directory to the main project directory.

[[Image:Eclipse-05.png]]

Now go to the '''Environment Tab''' and add a new variable called path. Add the same thing that appears in your mingenv.bat file here.

[[Image:Eclipse-06.png]]

[[Image:Eclipse-07.png]]

Click on '''C/C++ Project Paths''' and then the tab '''Path Containers'''. Click '''Add...''', choose '''Discovered scanner configuration container''', '''Next''', '''Discovered Paths''', and '''Finish'''.

Now go to '''C/C++ Include Paths and Symbols'''. Click '''Add Contributed''' and choose the '''Discovered scanner configuration container''', then '''Discovered Paths'''. Then click '''Add External Include Path''' and add the path to your GTK folder (probably something like c:\gtk210).

[[Image:Eclipse-08.png]]

You should now be able to use the '''Project > Build All''' command, capturing the output onto Eclipse's console.

== Debugging ==

You need to make a couple of changes to the build.xml file and do a clean rebuild. First, add -g to the flags section:

<flags>
-Wall -O3
-mms-bitfields
'''-g'''
</flags>

Then avoid stripping symbol information from the exe by changing this line
strip="'''true'''" symfile="${build}/inkscape.dbg"
with this one
strip="'''false'''" symfile="${build}/inkscape.dbg"

Now you need to create a debugging instance in Eclipse. Click '''Run > Debug...'''. Click on '''C/C++ Local Application''' and then click the new button. Give the launch configuration a logical name such as Inkscape Debug.

These screenshots show you the values you have to change in each tab. Nothing else needs to change.

[[Image:Eclipse-09.png]]

[[Image:Eclipse-10.png]]

Now you can launch this new configuration and debug away!

(Don't worry about funny warnings about files or folders not existing - it doesn't seem to affect the use of the debugger. However, if you know how to fix it, please replace this comment with instructions.)

[[Category:Developer Documentation]]

Compiling Inkscape on Windows 32-bit

2015-03-05T10:01:33Z

BitBarrel: /* Set Environmental Variables */ Added restart required after environment variables set.

Debugging Inkscape

2015-03-05T09:11:52Z

BitBarrel: /* Debugging Tips for Windows */ Changed Using Eclipse link to Using Visual Studio

* If you're hunting down a GTK warning, you can set a breakpoint in gdb for "g_logv" so you can capture a backtrace. ("br g_logv", "run", "bt")

* If you're hunting down a g_assert, you can set a breakpoint in gdb for "g_assertion_message_expr" (or "g_assertion_message" maybe) to stop execution and make a backtrace.

* gdb can catch throwing of an exception. Type: "catch throw" and gdb will stop execution at the point of where the exception is thrown, without unwinding the stack, so you can get a backtrace!

* Bug list
- w32 version asks for (that crappy) Verdana typeface (which is not the most usual w32 typeface, also some users have deleted it to save disk space)

== Debugging Tips for OS X ==

When running the .app package for OS X, it can be difficult to get a backtrace because the application binary is launched through another application and 2 scripts. One way to get a backtrace is:
* Add '-g' to $CFLAGS in your build script before building.
* Remove the signal() calls (<code>segv_handler = signal (SIGSEGV,... </code>) ) in inkscape_application_init() in src/inkscape.cpp.
* In the Resources/bin/inkscpe script, change the last line from:
<code>exec "$CWD/inkscape-bin" "$@"</code>
to:
<code>exec "/usr/bin/gdb" "stuff/inkscape-bin"</code>
* Build and package the app (see [[CompilingMacOsX]]).
* Run the application in Terminal:
<code>
$ cd packaging/macosx
$ Inkscape.app/Contents/MacOS/Inkscape
...
(gdb) run
</code>

== Debugging Tips for Windows ==

First, have a look at the [[Using Visual Studio]] page for how to use that program on Windows to debug Inkscape.

Second, make use of the '''View > Messages...''' dialog from within the program. Capturing the log here will show you messages printed with g_message(), g_warning(), and g_error()..

Finally, look into [http://wiki.inkscape.org/wiki/index.php/FAQ#I.27m_on_Windows.2C_and_command_line_parameters_don.27t_seem_to_work.21 how to compile Inkscape as a command line app] so you can capture debug messages at the prompt, more like you would do in Linux.

===How Johan works===
Of course I am always compiling with [http://wiki.inkscape.org/wiki/index.php/FAQ#I.27m_on_Windows.2C_and_command_line_parameters_don.27t_seem_to_work.21 -mconsole, instead of -mwindows]. I don't compile with -g or any other extra flags. This is unnecessary and reduces build times significantly.

For example for crashes, usually I add g_message("blah") to the code to see where the execution of code goes and to see on which line things break:

g_message("1");
some_piece_of_code1();
g_message("2");
some_piece_of_code2();
g_message("3");
some_piece_of_code3();
g_message("4");
some_piece_of_code4();
g_message("5");

If I see the message "2" but not "3" I know the crash happened in some_piece_of_code2.

I also use GDB to get backtraces. Again, don't compile with -g. Not necessary at all! One of the problems with running Inkscape in gdb is that you cannot open a file with the file dialog: Inkscape will hang. I don't know the reason, but I do know a solution! Open the file through Inkscape's cmdline parameters:

D:\Inkscape\inkscape>gdb
GNU gdb 6.6
Copyright (C) 2006 Free Software Foundation, Inc.
GDB is free software, covered by the GNU General Public License, and you are
welcome to change it and/or distribute copies of it under certain conditions.
Type "show copying" to see the conditions.
There is absolutely no warranty for GDB. Type "show warranty" for details.
This GDB was configured as "i686-pc-mingw32".
(gdb) file inkscape.exe inkscape.dbg
Reading symbols from D:\Inkscape\inkscape/inkscape.exe...(no debugging symbols found)...done.
Reading symbols from D:\Inkscape\inkscape/inkscape.dbg...done.
(gdb) run Tekening.svg
Starting program: D:\Inkscape\inkscape/inkscape.exe Tekening.svg

===Example of how to fix a bug===
See this bugreport:
https://bugs.launchpad.net/inkscape/+bug/169135

I started gdb like above. And then I saw this:
Program received signal SIGSEGV, Segmentation fault.
0x005c94ec in Inkscape::UI::Widget::Scalar::setValue ()
(gdb) bt
#0 0x005c94ec in Inkscape::UI::Widget::Scalar::setValue ()
#1 0x0044fc11 in Inkscape::CanvasXYGrid::readRepr ()
#2 0x0044de22 in Inkscape::CanvasXYGrid::onReprAttrChanged ()

The crashing piece of code looked like this:

void Scalar::setValue(double value)
{
g_assert(_widget != NULL);
setProgrammatically = true; // callback is supposed to reset back, if it cares
static_cast<Gtk::SpinButton*>(_widget)->set_value(value);
}

Nothing much can crash there, the assert checks that _widget is not NULL, and then the cast is valid aswell. So what crashed? What happens is that the setValue method is called for an object that does not exist. _widget is not NULL, but "this" is! this->_widget would crash. g_assert (this != NULL) would give an assertion message. (checked by adding " if (this==NULL) g_message("ja hoor"); " )

It is absurd to check for "this" to be non-NULL at the start of every method, so the bug is not in this method but in the function calling it! That's why we turn our attention to Inkscape::CanvasXYGrid::readRepr ().

readRepr is long, but we only have to look where it does something with a Scalar widget. It's the validateScalar functions. When we comment those out, the bug is solved. (it causes another bug with the specific SVG file, where Inkscape hangs when the grid spacing equals zero. validateScalar used to check for that...)
The strange thing is that the widgets are all created and initialized in the constructor of CanvasXYGrid. So perhaps readRepr is being called *during* construction of CanvasXYGrid, while the Scalar widget is still invalid? Using the g_message tip above I found out that the problem code was:
sutemp = _rsu_sx.getSU();
g_message("CanvasXYGrid 1");
sutemp->setDigits(4);
g_message("CanvasXYGrid 2");

Researching the setDigits path, I could not find a bug. Then it hit me: _rsu_sx is initialized, then readRepr is called, but this is before _rsu_sy is initialized. Then

void RegisteredScalarUnit::setValue (double val)
{
_widget->setValue (val);
}

is called, but _widget is still NULL, hence the crash.
As usual, the fix is easy:
void RegisteredScalarUnit::setValue (double val)
{
if (_widget)
_widget->setValue (val);
}

Don't forget to fix the setValue methods of the other Registered widgets!!!

The fix can be seen in [http://inkscape.svn.sourceforge.net/viewvc/inkscape?view=rev&revision=16544 SVN revision 16544].

===Problems running GDB===
From an inexperienced user of GDB just trying to get backtraces, here is a tip I found running gdb.

I simply downloaded the latest version of Inkscape Dev full debug, extracted to a directory and ran gdb exactly as above from within the directory, only changing the name of the svg file.

Everything went exactly as above for "file inkscape.exe inkscape.dbg", however after executing the "run {filename.svg}" command, I received the following message;
Program received signal SIGSEV, Segmentation fault.
0x03de8cf1 in xslDebugStatus ()

This has stumped me once before, but this time I checked out the help menus, and found under "help running" that I could simply type "continue". I figured that xslDebugStatus was nothing to do with the Inkscape program itself, but more to do with gdb, and after typing "continue" it seems to run Inkscape under gdb as normal, allowing backtraces.

===guard32.dll error===
If you try to run gdb but it halts, complaining about guard32.dll, your Comodo Firewall installation is blocking gdb. Easiest way around this is to '''disable the Defense+ module completely''' -- open up Comodo Firewall, click on Defense+, Defense+ settings, set Security Level to "Disabled", and check "Deactivate the Defense+ permanently". Reboot.

== Debugging Tips for Linux ==

Debugging Inkscape on Linux is most easily done using Eclipse (or any other IDE). When however a breakpoint is reached while Inkscape is in a pointer grab (for example when dragging a control point or drawing a path), then X will stop responding. If you want to debug in such a case then you'll have to use gdb from the console. In Fedora 10 you'll get to the console when pressing ctrl-alt-F5. Now enter
declare -x DISPLAY=":0"
and startup gdb to load Inkscape and the debugging symbols, set your breakpoints, and start Inkscape. Now you can switch back to X (ctrl-alt-F1) and interact with Inkscape. When Inkscape stops responding because it hit a breakpoint, switch back to the console and do your debugging.

If you happen to run into some issues with one of the Gtk+ libraries and want to step through its code using the debugger, you will have to install its debugging symbols. For Fedora 10 you can simply enable the fedora-debuginfo repository in /etc/yum.repos.d/fedora.repo and then use yum to install for example the "gtk2-debuginfo" and "glib-debuginfo" package. For other distros you'll find some usefull information here:
http://live.gnome.org/GettingTraces/DistroSpecificInstructions

[[Category:Developer Documentation]]

Using Visual Studio

2015-03-05T09:08:47Z

BitBarrel: Under construction

= Under construction =

Inkscape

2015-03-05T09:05:46Z

BitBarrel: /* First Steps */ Added Using Visual Studio

This is a freeform area for Inkscape development and discussion.
Curious about [[WikiSyntax]]?

Other languages: [[Inkscape en español|Wiki en español]], [[L'Inkscape en Català|Wiki en Català]], [[Inkscape em Português|Wiki em Português]], [[Startseite|Wiki auf deutsch]]...

{| cellspacing="11" style="width:100%;"
|-style="vertical-align:top;"
| style="width:33%;background-color: #E6E6E6; padding:.5em;"|
=== Project Info ===
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] - Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] - Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] - Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Contact information]] - the developers' e-mails and SVN nicknames
* [[InkscapeInvariants|Inkscape's Mission]]
* [[CommunicationChannels|Communication Channels]]: how to reach us
* [[AnnouncementToSodipodi|Announcement To Sodipodi]]: this started it all
* [[Branding]]
* [[ContactInfo|Contact Information]]: who's behind Inkscape
* [[Travel Reimbursement Policy]]

|style="width:33%;;background-color: white; padding:.5em;"|

=== User Documentation ===
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] - where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] - what's needed to save in some formats
* [[Effect requirements]] - what's needed to use some effects
* [[Effect reference]] - what each effect does
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] - recovery in case Inkscape crashed
* [[Release notes]]
** '''for version [[Release notes/0.92|0.92]] (active development)'''
** '''for version [[Release notes/0.91|0.91]] (current release)'''
** older versions: [[Release notes/0.48.5|0.48.5]] [[Release notes/0.48.4|0.48.4]] [[Release notes/0.48.3|0.48.3]], [[Release notes/0.48.2|0.48.2]], [[Release notes/0.48.1|0.48.1]], [[Release notes/0.48|0.48]], [[Release notes/0.47|0.47]]
* [[Announcing Releases]]
* [[Tricks and tips]] - miscellaneous advice, may be slightly outdated

|style="width:33%;background-color: #E6E6E6; padding:.5em;"|

=== Help Inkscape Without Coding ===
* [[Bug management]]
* [[Testing]]
* [[Translation information]]
* [[Editing Inkscape's website|Website]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Marketing Scratchpad]]

* [[HelpWanted]]
* [[BugTriageProjects]]
* [[CreatingDists]]: how to build packages
* [[StableBranchUpdates]]
* [[UpdatingTrackerItems]]
* [[TutorialsAndHelp]]
* [[How_To_Start_A_Page]] how to use the wiki
* [[CreatingScreencasts]]
* [[AboutScreenContest]]
|}

{| cellspacing="0" style="width: 100%; background-color: white; border-width:1px; border-style:solid; border-color:#62C012; align:left; padding:11px 0em 0em 11px;"
|- style="vertical-align:top;"
| colspan="2"|

=== Developer Documentation ===
|- style="vertical-align:top;"
| style="width:50%;|
==== First Steps ====
* [[Working with Bazaar]] - How to obtain the source code. A quick start on how to use our version control system
* [[Compiling Inkscape|Compilation]]
* [[Using Eclipse]] - Debug Inkscape on Windows using Eclipse (outdated)
* [[Using Visual Studio]] - Debug Inkscape on Windows using Microsoft Visual Studio
* [[Developer manual]] - various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] - random tips to help debug problems
* [[Project organization]] - procedures, hierarchy, developer roles and the likes
* [[Janitorial tasks]] - small tasks that need doing
* [[Doxygen documentation]]
* [[Working with SVN]] - besides the code in Bazaar, we still have some things in SVN.

==== Developer tutorials ====
* [[Architectural overview]] - a high-level look at Inkscape
* [[Preferences subsystem]] - creating and using preference values
* XML subsystem (WIP) - how to manipulate the XML representation of a document
* Display subsystem (WIP) - how to make things appear on the canvas
* Tools subsystem (WIP) - how to create a new tool
* [[Creating a new SPObject]]
* Extensions
** [[Extension subsystem]] - an overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]]
** [[Python modules for extensions]] - some helpful routines for use in Python script extensions
* [[Creating Live Path Effects]]
* [[Boost shared pointers]]
* [[Using libsigc++ signals]]
* [[Windows development on Linux]]

==== Miscellaneous ====
* [[INX extension descriptor format]]
* [[Inkscape-specific XML attributes]] - documentation of attributes from Inkscape's XML namespace

* [[Extension repository]]: an Internet central for Inkscape Extensions
* [[Related programs]]

| style="width:50%;|
==== Continuous Integration (Automated testing) ====
* [http://jenkins.inkscape.org Our main testing website (Jenkins)]
* [[How to contribute to automated tests]]
* [[Jenkins server setup]]

==== Development Discussion ====
* [[Roadmap]]: the main todo list
* [[Dependencies]] - what libs are needed to build Inkscape
* [[C++11]] - What C++11 features can be used
* [[NewFeatureProposals]]
* [[ExtensionArchitectureProposals]]
* [[Coding Style|Coding Style Discussion]]
* [[FileTypes]]
* [[ApplicationIcons]] (Application + Interface)
* [[Icons]]
* [[InkscapeColor]]
* [[PrintingSubsystem]]
* [[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] - [[W3C]] full test suite
* [[CSS Support]]
* [[Google Summer Of Code]]
* [[Improved Media Management]]
* [[UI MockupScreenshots]]
* [[Swatch Book]]
* [[Tablet Dialog]]
* [[ViewBoxToDo]] View box support info
* [[Caching]]
* [[UI and Document coordinates‎]]
* [[Mipmapping]]
* [[GtkMMification]]: replace C boilerplate with gtkmm objects

===Lib2Geom===
*[[lib2geom]]
*[[lib2geom Goals]]
*[[lib2geom FAQ]]
*[[lib2geom SVN Repository Guide]]
*[[WorkingWith2GeomFAQ]]: real-life questions answered about using 2Geom in real code
*[[lib2geom py2geom]]: python bindings to 2geom. With this you can use the power of 2geom in python scripts.

|- style="vertical-align:top;"
| style="width:50%;|
==== User Interface Discussion ====
* [[Translation_information]]
* [[AddingInterfaceVerbs]]
* [[AccessibleGraphics]]
* [[ObjectManager]]
* [[DialogsReorganization]]
* [[ModalInterfaces]]
* [[TextUsability]]: text tool /dialog dialog
* [[KeyboardShortcutsToDo]]
** [[KeyboardProfiles]]: how you can help
* [[StatusbarAPI]]
* [[Animation-(Timeline)]]
* [[Free Desktop Graphic Suite]]

| style="width:50%; |
|}

* [[WikiAttic]]: pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:About Inkscape]]
[[Category:User Documentation]]

Compiling Inkscape on Windows 32-bit

2015-03-05T09:01:16Z

BitBarrel: /* Building Inkscape */ Added setting of Environment Variables in Windows and some reformatting

'''For 64 bit: see [[Compiling Inkscape on Windows 64-bit]]'''

----

Inkscape was originally written for Linux, but it has been ported to other platforms, including Windows. Since Windows is not POSIX compliant and doesn't have several features useful to developers (like package management), compiling Inkscape on Windows is more tedious than on Linux, but perfectly possible. To make it easier, we have compiled a package that contains all the libraries you need to build Inkscape. This reduces the effort of compiling Inkscape to: download and install 3 programs, download library package, download sourcecode, and you are ready to go.

==Setting up the build environment==

To develop Inkscape, you will need the following things:

* [http://wiki.bazaar.canonical.com/WindowsDownloads Bazaar]
* [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] programs: puttygen.exe and pageant.exe
* TDM's GCC (MingW): Please use exactly the [http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.1006.0/tdm-gcc-4.6.1.exe/download version 4.6.1 32bit bundle installer] and follow the instructions below. In the setup, '''Uncheck''' the [''Check for updated files on the TDM-GCC server''] when installing, or it will install a newer version. Newer versions (tdm-gcc-4.7+) introduce important changes in gcc and don't work with the current Inkscape devlibs (see [http://old.nabble.com/Compiling-on-Windows-7-x64-td34601489.html developpers' list discussion]).
* Launchpad account

In order to build the installer (not needed for most developers):
* [http://sourceforge.net/projects/nsis/files/NSIS%202/2.46/nsis-2.46-setup.exe/download NSIS 2.46]

===Install the compiler===
Run the TDM-MinGW installer:
# Install in a path that doesn't contain spaces. The path 'C:\mingw' is ideal beacuse it is currently set in the <tt>mingwenv.bat</tt> file (along with the location of devlibs).
#* TDM-MinGW's default install option may be to a different location. You will have to edit the <tt>mingwenv.bat</tt> file to point there.
#* If you install it into another path, set the environment variable MINGW_PATH to the TDM-MinGW installation directory, e.g. the one containing <tt>README-tdm-gcc.txt</tt> (right click My Computer -> Properties -> Advanced -> Environment Variables).
# Be sure to enable the "GCC -> openmp support" checkbox from the components list

===Create your Launchpad account===
You can skip this step (or do it later) if you just want to download the sources, but not submit your changes.

If you do not have an SSH public/private key pair to identify yourself:
*run the program puttygen.exe to generate an SSH key
*save both its parts.
Log into your Launchpad account, go to your profile page and add the public part of the generated key to the list of SSH keys. Run the program pageant.exe (you can add it to Autorun). A tray icon should appear. Right click it, select "Add Key" and pick the private key file you have just generated from the dialog. Note that you need to repeat this after every login whenever you want to access Launchpad.

Now set up Bazaar. First tell it who you are, then associate with your Launchpad account. You need to use the account name (e.g. johnq), not the display name.(John Q. Public).

C:\> bzr whoami "''Your Name'' <''your_real_email@example.com''>"
C:\> bzr launchpad-login ''your_launchpad_account''

===Install the developer libraries===
Check out Inkscape Devlibs into C:\devlibs. If you check them out elsewhere, set the environment variable DEVLIBS_PATH to the path where they are. Devlibs are a bundle of all the libraries needed to compile Inkscape. If you experience any problems, make sure you have an up to date copy of those libraries and an up to date checkout of Inkscape source. To reduce the size of the download, pass the <tt>--lightweight</tt> parameter.

C:\> bzr checkout --lightweight lp:inkscape-devlibs devlibs

To update devlibs:

C:\devlibs> bzr update

All Inkscape developers can commit to the devlibs trunk. Advanced information about Devlibs, mainy useful when you want to update them to newly released versions of upstream libraries, is available here: [[Inkscape Devlibs]].
You can see some infomation from [https://launchpad.net/inkscape-devlibs launchpad:inkscape-devlibs] and [http://bazaar.launchpad.net/~inkscape.dev/inkscape-devlibs/trunk/files trunk/files].

== Obtaining Inkscape source code ==

You can obtain released Inkscape source from a tarball. Since version 0.47 they are hosted on [https://launchpad.net/inkscape Inkscape's Launchpad page]. There are ready-made installers provided, so there's usually little reason to compile the stable version yourself.

To obtain cutting edge code, check out Inkscape source from the Bazaar repository. You can also use the TortoiseBZR shell extensions to do this. The recommended way is to first create a shared repository, then check out the Inkscape branch into that shared repository. Using this setup, branching will be a lot faster.

C:\src\inkscape> bzr init-repo --rich-root .
C:\src\inkscape> bzr upgrade
C:\src\inkscape> bzr checkout lp:inkscape trunk

If you don't want to create any branches, you can skip the shared repository step.

C:\src> bzr checkout lp:inkscape

'''IMPORTANT:''' make sure that the path to your Inkscape source checkout does not contain spaces. Unix tools do not like them and you will end up with a lot of error messages about missing files.

== Set Environmental Variables ==

First set up the environmental variables. You need to run mingwenv once per console session like this:
C:\src\inkscape\trunk> mingwenv
Or you can set the paths in the Windows system settings. Go to (Win 7):

Start->Control Panel ->System and Security->System->Advanced system settings->Advanced->Environment variables->System variables->New.
Add these variable names and values: 
DEVLIBS_PATH c:\devlibs 
MINGW_PATH c:\mingw 
MINGW_BIN c:\mingw\bin 
PKG_CONFIG_PATH c:\devlibs \lib\pkgconfig 
CMAKE_PREFIX_PATH c:\devlibs 
GTKMM_BASEPATH c:\devlibs 

Also, edit the PATH variable, and add these if not already present: 
c:\mingw\bin;c:\devlibs\python;c:\devlibs\bin

== Compile the Build Tool ==

Now compile the build tool. (Try the following command one by one. if that command fails)

C:\src\inkscape\trunk> g++ buildtool.cpp -o btool
C:\src\inkscape\trunk> g++ buildtool.cpp -o btool -fopenmp
C:\src\inkscape\trunk> g++ -DNEED_GETTIMEOFDAY buildtool.cpp -o btool -fopenmp

== Building Inkscape ==

Finally initiate the compilation. Get a coffee or take your dog out for a walk, because it will take a rather long time. If you have a multicore processor, add "-j 8" to use (for example) 8 parallel compilation threads.

C:\src\inkscape\trunk> btool -j 8

Once everything is done, there should be an <tt>inkscape</tt> directory that contains the Inkscape executable and libraries needed to run it.

== Rebuilding ==

If you have only changed a few files and want to rebuild, delete the <tt>inkscape</tt> directory and run <tt>btool</tt> again.

To rebuild from scratch, execute the following sequence of commands:
C:\src\inkscape\trunk> btool clean
C:\src\inkscape\trunk> btool

== Dealing With Build Errors ==
Feel free to add any questions or answers you have in here;

'''Q''' - My firewall software (Comodo's Defense+ component or similar) stopped the process continuing to the next step in the build, because I wasn't there to permit an action and it timed out. What can I do?

'''A1''' - The best thing is to disable stuff like Defense+ (put it in learning mode works) because it will stop any process that is not approved, and building makes new files which can't be approved before they're built. Disabling Comodo's Defense+ does not disable your firewall, either inbound or outbound, but just the part that scans every application for suspicious operations. Other firewalls etc may vary.

'''A2''' - If that doesn't suit, often you can simply run btool again and wait for Defense+ (or similar) to ask for approval for the process, and it will then continue as normal with the build. But remember that approving all the processes involved in the build process once doesn't mean they will all slip through next time.

'''A3''' - This is the more complex way to continue, but may help if you have problems with A2. If you know the stage the process was meant to be up to (look at the output in the command windows and compare to the stages in the ''build.xml'' file), you can start again from there.

You may see something like this in the command window;
=============================
## Target : link : link objects and library to create executable
---- task : rc
============ cmd ============
windres -o build/inkres.o --include-dir=src src/inkscape.rc
=============================
---- task : link
This will likely be followed by an error message. This means you were at the ''link'' stage

Now simply type;
...>btool ''stage''
Or in this case
...>btool link
And the build will continue from there.

After this, you will probably have to step through the remaining stages manually, one by one. The stages can include (see build.xml, where each stage is labelled 'target name="''target''"') ''init'', ''touchabout'', ''compile'', ''java'', ''lib'', ''i18n'', ''link'', ''linkinkview'', ''dist'', ''dist-all'', ''clean''.

'''Q''' - How do I rebuild just one ''file.o'' file? For instance if one particular file has gone wrong, or I want to try patching just one part of the code.

'''A''' - To find the right command for building any particular file in Inkscape, just look in the compile.lst after you have used btool once. Search for the name of the particular file (eg: print.cpp) and you will find the command used to compile it. You'll need to paste this into a text file, remove any carriage reurns and then paste that onto the command line.

'''Q''' - After I patched a file, I left a backup of the old file in the same directory called Copy of{filename}.cpp. The compiler complains about this file when building and stops.

'''A''' - Do not leave anything with a suffix .cpp in the source directories, apart from the original (or patched) source files. The build tool will try to compile everything ending in .cpp and will complain. If you backup an old file in the same directory before patching, call it {filename}.cpp.old or similar.

'''Q''' - I think I followed the instruction above. What could have caused the compiling error like this for src/extension/internal/pdfinput/pdf-parser.cpp?

src/extension/internal/pdfinput/pdf-parser.cpp:2248: error: no matching function for call to 'GfxFont::getNextChar(char*&, int&, CharCode*, Unicode [8], int, int*, double*, double*, double*, double*)'

Same error for line 2297 as well.

=== For more information ===
There is some old information on building Inkscape with either Mingw on Windows, or a cross-compiler on Linux, at http://inkscape.modevia.com/win32_inkscape_org/win32buildnotes.html
and old files mey be
http://inkscape.modevia.com/win32libs/
== Creating an installer ==

To create the '''inkscape-$RELEASE-win32.exe''' setup package you need the '''NSIS''' installer on your PC. Get that from http://nsis.sf.net .
You have successfully built Inkscape and everything is in the ...\inkscape\ directory.
Open the ...\packaging\win32\inkscape.nsi using the NSIS program and compile the package. Sooo easy :-)

The new wix installer in the packaging\wix directory creates msi packages. You need the '''windows installer XML''' package; get it from here http://wixtoolset.org/. Follow the instructions in the README file in the packaging\wix directory. The installer scripts parse version information from the inkscape.rc file. The generated packed is named as:

'''inkscape-$RELEASE.msi'''

== Note about Unicode ==

The GTK stack depends on functions only present in NT-based Windows (2000 and later). Therefore, Inkscape code can assume that Unicode functions from the Windows API (like GetCommandLineW) are always present. Note however that you should use the GLib/GTK functions rather the Windows API whenever possible.

=See also=
*[[Compiling Inkscape]]

[[Category:Developer Documentation]]

Compiling Inkscape on Windows 32-bit

2015-03-04T08:45:11Z

BitBarrel: /* Building Inkscape */ rephrase

'''For 64 bit: see [[Compiling Inkscape on Windows 64-bit]]'''

----

Inkscape was originally written for Linux, but it has been ported to other platforms, including Windows. Since Windows is not POSIX compliant and doesn't have several features useful to developers (like package management), compiling Inkscape on Windows is more tedious than on Linux, but perfectly possible. To make it easier, we have compiled a package that contains all the libraries you need to build Inkscape. This reduces the effort of compiling Inkscape to: download and install 3 programs, download library package, download sourcecode, and you are ready to go.

==Setting up the build environment==

To develop Inkscape, you will need the following things:

* [http://wiki.bazaar.canonical.com/WindowsDownloads Bazaar]
* [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] programs: puttygen.exe and pageant.exe
* TDM's GCC (MingW): Please use exactly the [http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.1006.0/tdm-gcc-4.6.1.exe/download version 4.6.1 32bit bundle installer] and follow the instructions below. In the setup, '''Uncheck''' the [''Check for updated files on the TDM-GCC server''] when installing, or it will install a newer version. Newer versions (tdm-gcc-4.7+) introduce important changes in gcc and don't work with the current Inkscape devlibs (see [http://old.nabble.com/Compiling-on-Windows-7-x64-td34601489.html developpers' list discussion]).
* Launchpad account

In order to build the installer (not needed for most developers):
* [http://sourceforge.net/projects/nsis/files/NSIS%202/2.46/nsis-2.46-setup.exe/download NSIS 2.46]

===Install the compiler===
Run the TDM-MinGW installer:
# Install in a path that doesn't contain spaces. The path 'C:\mingw' is ideal beacuse it is currently set in the <tt>mingwenv.bat</tt> file (along with the location of devlibs).
#* TDM-MinGW's default install option may be to a different location. You will have to edit the <tt>mingwenv.bat</tt> file to point there.
#* If you install it into another path, set the environment variable MINGW_PATH to the TDM-MinGW installation directory, e.g. the one containing <tt>README-tdm-gcc.txt</tt> (right click My Computer -> Properties -> Advanced -> Environment Variables).
# Be sure to enable the "GCC -> openmp support" checkbox from the components list

===Create your Launchpad account===
You can skip this step (or do it later) if you just want to download the sources, but not submit your changes.

If you do not have an SSH public/private key pair to identify yourself:
*run the program puttygen.exe to generate an SSH key
*save both its parts.
Log into your Launchpad account, go to your profile page and add the public part of the generated key to the list of SSH keys. Run the program pageant.exe (you can add it to Autorun). A tray icon should appear. Right click it, select "Add Key" and pick the private key file you have just generated from the dialog. Note that you need to repeat this after every login whenever you want to access Launchpad.

Now set up Bazaar. First tell it who you are, then associate with your Launchpad account. You need to use the account name (e.g. johnq), not the display name.(John Q. Public).

C:\> bzr whoami "''Your Name'' <''your_real_email@example.com''>"
C:\> bzr launchpad-login ''your_launchpad_account''

===Install the developer libraries===
Check out Inkscape Devlibs into C:\devlibs. If you check them out elsewhere, set the environment variable DEVLIBS_PATH to the path where they are. Devlibs are a bundle of all the libraries needed to compile Inkscape. If you experience any problems, make sure you have an up to date copy of those libraries and an up to date checkout of Inkscape source. To reduce the size of the download, pass the <tt>--lightweight</tt> parameter.

C:\> bzr checkout --lightweight lp:inkscape-devlibs devlibs

To update devlibs:

C:\devlibs> bzr update

All Inkscape developers can commit to the devlibs trunk. Advanced information about Devlibs, mainy useful when you want to update them to newly released versions of upstream libraries, is available here: [[Inkscape Devlibs]].
You can see some infomation from [https://launchpad.net/inkscape-devlibs launchpad:inkscape-devlibs] and [http://bazaar.launchpad.net/~inkscape.dev/inkscape-devlibs/trunk/files trunk/files].

== Obtaining Inkscape source code ==

You can obtain released Inkscape source from a tarball. Since version 0.47 they are hosted on [https://launchpad.net/inkscape Inkscape's Launchpad page]. There are ready-made installers provided, so there's usually little reason to compile the stable version yourself.

To obtain cutting edge code, check out Inkscape source from the Bazaar repository. You can also use the TortoiseBZR shell extensions to do this. The recommended way is to first create a shared repository, then check out the Inkscape branch into that shared repository. Using this setup, branching will be a lot faster.

C:\src\inkscape> bzr init-repo --rich-root .
C:\src\inkscape> bzr upgrade
C:\src\inkscape> bzr checkout lp:inkscape trunk

If you don't want to create any branches, you can skip the shared repository step.

C:\src> bzr checkout lp:inkscape

'''IMPORTANT:''' make sure that the path to your Inkscape source checkout does not contain spaces. Unix tools do not like them and you will end up with a lot of error messages about missing files.

== Building Inkscape ==

Now set up the environmental variables. You need to run mingwenv once per console session, or set the paths in Windows system settings.
C:\src\inkscape\trunk> mingwenv

Now compile the build tool. (Try the following command one by one. if that command fails)

C:\src\inkscape\trunk> g++ buildtool.cpp -o btool
C:\src\inkscape\trunk> g++ buildtool.cpp -o btool -fopenmp
C:\src\inkscape\trunk> g++ -DNEED_GETTIMEOFDAY buildtool.cpp -o btool -fopenmp

Finally initiate the compilation. Get a coffee or take your dog out for a walk, because it will take a rather long time. If you have a multicore processor, add "-j 8" to use (for example) 8 parallel compilation threads.

C:\src\inkscape\trunk> btool -j 8

Once everything is done, there should be an <tt>inkscape</tt> directory that contains the Inkscape executable and libraries needed to run it.

== Rebuilding ==

If you have only changed a few files and want to rebuild, delete the <tt>inkscape</tt> directory and run <tt>btool</tt> again.

To rebuild from scratch, execute the following sequence of commands:
C:\src\inkscape\trunk> btool clean
C:\src\inkscape\trunk> btool

== Dealing With Build Errors ==
Feel free to add any questions or answers you have in here;

'''Q''' - My firewall software (Comodo's Defense+ component or similar) stopped the process continuing to the next step in the build, because I wasn't there to permit an action and it timed out. What can I do?

'''A1''' - The best thing is to disable stuff like Defense+ (put it in learning mode works) because it will stop any process that is not approved, and building makes new files which can't be approved before they're built. Disabling Comodo's Defense+ does not disable your firewall, either inbound or outbound, but just the part that scans every application for suspicious operations. Other firewalls etc may vary.

'''A2''' - If that doesn't suit, often you can simply run btool again and wait for Defense+ (or similar) to ask for approval for the process, and it will then continue as normal with the build. But remember that approving all the processes involved in the build process once doesn't mean they will all slip through next time.

'''A3''' - This is the more complex way to continue, but may help if you have problems with A2. If you know the stage the process was meant to be up to (look at the output in the command windows and compare to the stages in the ''build.xml'' file), you can start again from there.

You may see something like this in the command window;
=============================
## Target : link : link objects and library to create executable
---- task : rc
============ cmd ============
windres -o build/inkres.o --include-dir=src src/inkscape.rc
=============================
---- task : link
This will likely be followed by an error message. This means you were at the ''link'' stage

Now simply type;
...>btool ''stage''
Or in this case
...>btool link
And the build will continue from there.

After this, you will probably have to step through the remaining stages manually, one by one. The stages can include (see build.xml, where each stage is labelled 'target name="''target''"') ''init'', ''touchabout'', ''compile'', ''java'', ''lib'', ''i18n'', ''link'', ''linkinkview'', ''dist'', ''dist-all'', ''clean''.

'''Q''' - How do I rebuild just one ''file.o'' file? For instance if one particular file has gone wrong, or I want to try patching just one part of the code.

'''A''' - To find the right command for building any particular file in Inkscape, just look in the compile.lst after you have used btool once. Search for the name of the particular file (eg: print.cpp) and you will find the command used to compile it. You'll need to paste this into a text file, remove any carriage reurns and then paste that onto the command line.

'''Q''' - After I patched a file, I left a backup of the old file in the same directory called Copy of{filename}.cpp. The compiler complains about this file when building and stops.

'''A''' - Do not leave anything with a suffix .cpp in the source directories, apart from the original (or patched) source files. The build tool will try to compile everything ending in .cpp and will complain. If you backup an old file in the same directory before patching, call it {filename}.cpp.old or similar.

'''Q''' - I think I followed the instruction above. What could have caused the compiling error like this for src/extension/internal/pdfinput/pdf-parser.cpp?

src/extension/internal/pdfinput/pdf-parser.cpp:2248: error: no matching function for call to 'GfxFont::getNextChar(char*&, int&, CharCode*, Unicode [8], int, int*, double*, double*, double*, double*)'

Same error for line 2297 as well.

=== For more information ===
There is some old information on building Inkscape with either Mingw on Windows, or a cross-compiler on Linux, at http://inkscape.modevia.com/win32_inkscape_org/win32buildnotes.html
and old files mey be
http://inkscape.modevia.com/win32libs/
== Creating an installer ==

To create the '''inkscape-$RELEASE-win32.exe''' setup package you need the '''NSIS''' installer on your PC. Get that from http://nsis.sf.net .
You have successfully built Inkscape and everything is in the ...\inkscape\ directory.
Open the ...\packaging\win32\inkscape.nsi using the NSIS program and compile the package. Sooo easy :-)

The new wix installer in the packaging\wix directory creates msi packages. You need the '''windows installer XML''' package; get it from here http://wixtoolset.org/. Follow the instructions in the README file in the packaging\wix directory. The installer scripts parse version information from the inkscape.rc file. The generated packed is named as:

'''inkscape-$RELEASE.msi'''

== Note about Unicode ==

The GTK stack depends on functions only present in NT-based Windows (2000 and later). Therefore, Inkscape code can assume that Unicode functions from the Windows API (like GetCommandLineW) are always present. Note however that you should use the GLib/GTK functions rather the Windows API whenever possible.

=See also=
*[[Compiling Inkscape]]

[[Category:Developer Documentation]]

Compiling Inkscape on Windows 32-bit

2015-03-04T07:45:58Z

BitBarrel: /* Building Inkscape */

'''For 64 bit: see [[Compiling Inkscape on Windows 64-bit]]'''

----

Inkscape was originally written for Linux, but it has been ported to other platforms, including Windows. Since Windows is not POSIX compliant and doesn't have several features useful to developers (like package management), compiling Inkscape on Windows is more tedious than on Linux, but perfectly possible. To make it easier, we have compiled a package that contains all the libraries you need to build Inkscape. This reduces the effort of compiling Inkscape to: download and install 3 programs, download library package, download sourcecode, and you are ready to go.

==Setting up the build environment==

To develop Inkscape, you will need the following things:

* [http://wiki.bazaar.canonical.com/WindowsDownloads Bazaar]
* [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] programs: puttygen.exe and pageant.exe
* TDM's GCC (MingW): Please use exactly the [http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/Previous/1.1006.0/tdm-gcc-4.6.1.exe/download version 4.6.1 32bit bundle installer] and follow the instructions below. In the setup, '''Uncheck''' the [''Check for updated files on the TDM-GCC server''] when installing, or it will install a newer version. Newer versions (tdm-gcc-4.7+) introduce important changes in gcc and don't work with the current Inkscape devlibs (see [http://old.nabble.com/Compiling-on-Windows-7-x64-td34601489.html developpers' list discussion]).
* Launchpad account

In order to build the installer (not needed for most developers):
* [http://sourceforge.net/projects/nsis/files/NSIS%202/2.46/nsis-2.46-setup.exe/download NSIS 2.46]

===Install the compiler===
Run the TDM-MinGW installer:
# Install in a path that doesn't contain spaces. The path 'C:\mingw' is ideal beacuse it is currently set in the <tt>mingwenv.bat</tt> file (along with the location of devlibs).
#* TDM-MinGW's default install option may be to a different location. You will have to edit the <tt>mingwenv.bat</tt> file to point there.
#* If you install it into another path, set the environment variable MINGW_PATH to the TDM-MinGW installation directory, e.g. the one containing <tt>README-tdm-gcc.txt</tt> (right click My Computer -> Properties -> Advanced -> Environment Variables).
# Be sure to enable the "GCC -> openmp support" checkbox from the components list

===Create your Launchpad account===
You can skip this step (or do it later) if you just want to download the sources, but not submit your changes.

If you do not have an SSH public/private key pair to identify yourself:
*run the program puttygen.exe to generate an SSH key
*save both its parts.
Log into your Launchpad account, go to your profile page and add the public part of the generated key to the list of SSH keys. Run the program pageant.exe (you can add it to Autorun). A tray icon should appear. Right click it, select "Add Key" and pick the private key file you have just generated from the dialog. Note that you need to repeat this after every login whenever you want to access Launchpad.

Now set up Bazaar. First tell it who you are, then associate with your Launchpad account. You need to use the account name (e.g. johnq), not the display name.(John Q. Public).

C:\> bzr whoami "''Your Name'' <''your_real_email@example.com''>"
C:\> bzr launchpad-login ''your_launchpad_account''

===Install the developer libraries===
Check out Inkscape Devlibs into C:\devlibs. If you check them out elsewhere, set the environment variable DEVLIBS_PATH to the path where they are. Devlibs are a bundle of all the libraries needed to compile Inkscape. If you experience any problems, make sure you have an up to date copy of those libraries and an up to date checkout of Inkscape source. To reduce the size of the download, pass the <tt>--lightweight</tt> parameter.

C:\> bzr checkout --lightweight lp:inkscape-devlibs devlibs

To update devlibs:

C:\devlibs> bzr update

All Inkscape developers can commit to the devlibs trunk. Advanced information about Devlibs, mainy useful when you want to update them to newly released versions of upstream libraries, is available here: [[Inkscape Devlibs]].
You can see some infomation from [https://launchpad.net/inkscape-devlibs launchpad:inkscape-devlibs] and [http://bazaar.launchpad.net/~inkscape.dev/inkscape-devlibs/trunk/files trunk/files].

== Obtaining Inkscape source code ==

You can obtain released Inkscape source from a tarball. Since version 0.47 they are hosted on [https://launchpad.net/inkscape Inkscape's Launchpad page]. There are ready-made installers provided, so there's usually little reason to compile the stable version yourself.

To obtain cutting edge code, check out Inkscape source from the Bazaar repository. You can also use the TortoiseBZR shell extensions to do this. The recommended way is to first create a shared repository, then check out the Inkscape branch into that shared repository. Using this setup, branching will be a lot faster.

C:\src\inkscape> bzr init-repo --rich-root .
C:\src\inkscape> bzr upgrade
C:\src\inkscape> bzr checkout lp:inkscape trunk

If you don't want to create any branches, you can skip the shared repository step.

C:\src> bzr checkout lp:inkscape

'''IMPORTANT:''' make sure that the path to your Inkscape source checkout does not contain spaces. Unix tools do not like them and you will end up with a lot of error messages about missing files.

== Building Inkscape ==

Open the command prompt, navigate to the directory with Inkscape sources. First set up some environmental variables. You only need to do this once per console session. This will define the location of your downloaded ''MinGW'' and ''devlibs'' so inkscape can find them.
# Make sure you have correct '''DEVLIB_PATH''' and '''MINGW_PATH''' in system or edit and run mingwenv to set the environment variables.
C:\src\inkscape\trunk> mingwenv

Now compile the build tool. (Try the following command one by one. if that command fails)

C:\src\inkscape\trunk> g++ buildtool.cpp -o btool
C:\src\inkscape\trunk> g++ buildtool.cpp -o btool -fopenmp
C:\src\inkscape\trunk> g++ -DNEED_GETTIMEOFDAY buildtool.cpp -o btool -fopenmp

Finally initiate the compilation. Get a coffee or take your dog out for a walk, because it will take a rather long time. If you have a multicore processor, add "-j 8" to use (for example) 8 parallel compilation threads.

C:\src\inkscape\trunk> btool -j 8

Once everything is done, there should be an <tt>inkscape</tt> directory that contains the Inkscape executable and libraries needed to run it.

== Rebuilding ==

If you have only changed a few files and want to rebuild, delete the <tt>inkscape</tt> directory and run <tt>btool</tt> again.

To rebuild from scratch, execute the following sequence of commands:
C:\src\inkscape\trunk> btool clean
C:\src\inkscape\trunk> btool

== Dealing With Build Errors ==
Feel free to add any questions or answers you have in here;

'''Q''' - My firewall software (Comodo's Defense+ component or similar) stopped the process continuing to the next step in the build, because I wasn't there to permit an action and it timed out. What can I do?

'''A1''' - The best thing is to disable stuff like Defense+ (put it in learning mode works) because it will stop any process that is not approved, and building makes new files which can't be approved before they're built. Disabling Comodo's Defense+ does not disable your firewall, either inbound or outbound, but just the part that scans every application for suspicious operations. Other firewalls etc may vary.

'''A2''' - If that doesn't suit, often you can simply run btool again and wait for Defense+ (or similar) to ask for approval for the process, and it will then continue as normal with the build. But remember that approving all the processes involved in the build process once doesn't mean they will all slip through next time.

'''A3''' - This is the more complex way to continue, but may help if you have problems with A2. If you know the stage the process was meant to be up to (look at the output in the command windows and compare to the stages in the ''build.xml'' file), you can start again from there.

You may see something like this in the command window;
=============================
## Target : link : link objects and library to create executable
---- task : rc
============ cmd ============
windres -o build/inkres.o --include-dir=src src/inkscape.rc
=============================
---- task : link
This will likely be followed by an error message. This means you were at the ''link'' stage

Now simply type;
...>btool ''stage''
Or in this case
...>btool link
And the build will continue from there.

After this, you will probably have to step through the remaining stages manually, one by one. The stages can include (see build.xml, where each stage is labelled 'target name="''target''"') ''init'', ''touchabout'', ''compile'', ''java'', ''lib'', ''i18n'', ''link'', ''linkinkview'', ''dist'', ''dist-all'', ''clean''.

'''Q''' - How do I rebuild just one ''file.o'' file? For instance if one particular file has gone wrong, or I want to try patching just one part of the code.

'''A''' - To find the right command for building any particular file in Inkscape, just look in the compile.lst after you have used btool once. Search for the name of the particular file (eg: print.cpp) and you will find the command used to compile it. You'll need to paste this into a text file, remove any carriage reurns and then paste that onto the command line.

'''Q''' - After I patched a file, I left a backup of the old file in the same directory called Copy of{filename}.cpp. The compiler complains about this file when building and stops.

'''A''' - Do not leave anything with a suffix .cpp in the source directories, apart from the original (or patched) source files. The build tool will try to compile everything ending in .cpp and will complain. If you backup an old file in the same directory before patching, call it {filename}.cpp.old or similar.

'''Q''' - I think I followed the instruction above. What could have caused the compiling error like this for src/extension/internal/pdfinput/pdf-parser.cpp?

src/extension/internal/pdfinput/pdf-parser.cpp:2248: error: no matching function for call to 'GfxFont::getNextChar(char*&, int&, CharCode*, Unicode [8], int, int*, double*, double*, double*, double*)'

Same error for line 2297 as well.

=== For more information ===
There is some old information on building Inkscape with either Mingw on Windows, or a cross-compiler on Linux, at http://inkscape.modevia.com/win32_inkscape_org/win32buildnotes.html
and old files mey be
http://inkscape.modevia.com/win32libs/
== Creating an installer ==

To create the '''inkscape-$RELEASE-win32.exe''' setup package you need the '''NSIS''' installer on your PC. Get that from http://nsis.sf.net .
You have successfully built Inkscape and everything is in the ...\inkscape\ directory.
Open the ...\packaging\win32\inkscape.nsi using the NSIS program and compile the package. Sooo easy :-)

The new wix installer in the packaging\wix directory creates msi packages. You need the '''windows installer XML''' package; get it from here http://wixtoolset.org/. Follow the instructions in the README file in the packaging\wix directory. The installer scripts parse version information from the inkscape.rc file. The generated packed is named as:

'''inkscape-$RELEASE.msi'''

== Note about Unicode ==

The GTK stack depends on functions only present in NT-based Windows (2000 and later). Therefore, Inkscape code can assume that Unicode functions from the Windows API (like GetCommandLineW) are always present. Note however that you should use the GLib/GTK functions rather the Windows API whenever possible.

=See also=
*[[Compiling Inkscape]]

[[Category:Developer Documentation]]

Using Eclipse

2015-03-04T06:17:37Z

BitBarrel: added needs_update

{{Needs_update}}

'''Note:''' The instructions in this wiki are out of date and do not work anymore. This page is just a reference as it might provide you with a clue on how to get it to work. If you manage to get compiling and debugging to work under Windows using Eclipse, please modify this page accordingly.

Eclipse is a popular development tool used primarily with Java; however, C/C++ development can also be done. This page will help you set up Eclipse for coding, building, and debugging Inkscape.

= Eclipse on Fedora =

# Follow the ''Installation'' and ''Configuration'' steps of guide [http://wiki.bazaar.canaonical.com/BzrEclipse BzrEclipse] but be carefull:
#* At this moment, this How to is for a previous version of Eclipse (some dialogs and menus have changed)
#* ''bzr-xmloutput'' must be decompress in a folder named exactly ''xmloutput'' in Bazaar plugins directory

= Setup project in Eclipse =

Following steps are equivalent to:

checkout lp:inkscape /home/{USER_NAME}/workspace/Inkscape

In Eclipse:

# File > New > Project...
# Select Bazaar > Checkout as a new project
# Select ''Initialize a new branch location''
# Set ''Branch location'' to ''lp:inkscape''
# Select ''Create a project''
# Set ''Project name'' to ''Inkscape''

After quite a long time working, the Inkscape project appears in the Eclipse Explorer.

= Eclipse on Windows =

Running Eclipse provides a relatively easy and familiar way to work with Inkscape code on Windows. This section will explain how to make it happen.

'''Note:''' Some of these instructions may be applicable to development on Mac or Linux. Feel free to refactor them if you are adding information for those platforms.

== Initial Setup ==

First, make sure Inkscape compiles under windows using the command line to verify the source and dependencies are installed correctly. Follow the instructions on the [[Win32Port]] page under the heading '''Inkscape under Windows'''.

If you don't have Eclipse, [http://www.eclipse.org/downloads/ get it]. Check out the [http://help.eclipse.org/help32/index.jsp online help] if needed.

Next, you need to set up the necessary add-ons. Most important is the [http://www.eclipse.org/cdt/downloads.php CDT plug-in] which facilitates C/C++ development. You may also wish to add [http://subclipse.tigris.org/install.html Subclipse] for SVN access within Eclipse. Alternatively, many Windows users prefer to use [http://tortoisesvn.net/downloads TortoiseSVN], which works with Windows Explorer.

== Creating a Project ==

=== Subclipse (Outdated as version control is provided by Bazaar now) ===

The next step is to get the source code ready for use in Eclipse. Check [[WorkingWithSVN | here]] for general instructions for working with SVN; in this section, the aim is to show how to check out the code using Subclipse.

In Eclipse, we want the SVN perspective to be open. Click '''Window > Open Perspective > Other'''. Choose '''SVN Repository Exploring''' and click ok.

[[Image:Eclipse-01.png]]

In the '''SVN Repository''' tab, right click and choose '''New > Repository Location...'''.

[[Image:Eclipse-02.png]]

In the '''Location Url:''' box, paste the link https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk and click finish. This location will now show in the '''SVN Repository''' tab. You can expand the tree to see what is on the server.

Now right click the location name (which is really just the link given above), and click '''Checkout...'''. Choose '''Check out as a project configured using the New Project Wizard''' and the revision you want (probably Head), and click '''Finish'''.

In the New Project window that appears, choose '''C++ Project''' in Eclipse Europa (or in Callisto '''Standard Make C++ Project''') and click '''Next'''.

[[Image:Eclipse-Europa-ProjectType.png]]

Give your project a name such as InkscapeSVN. Uncheck the '''Use default location''' box so you can provide a better project location outside of your workspace, such as C:\InkscapeSVN. Select '''Executable (XL C/C++)''' as the project type, and '''XL C/C++ Tool Chain''' as the the Toolchain (this will not be necessary in Callisto (or before?) as this has been already been specified by selecting '''Standard Make C++ Project'''). Click '''Finish'''.

[[Image:Eclipse-Europa-CppProjectType.png]]

The source code will now be checked out - this may take a while. You will also now have a project in the '''C/C++ Perspective''' with whatever name you provided earlier.

=== TortoiseSVN (Outdated as version control is provided by Bazaar now) ===

To use TortoiseSVN instead of Subclipse to check out your project, open a Windows Explorer instance. Right click anywhere outside of an existing SVN tree and choose '''SVN Checkout...'''. Specify the link given above and the destination directory.

To get a project in Eclipse, go to the '''C/C++ Perspective'''.

In Eclipse Europa select '''File > New > C++ Project'''. Choose a project type of '''Executable (XL C/C++)'''.

In Eclipse Calisto right click in the '''C/C++ Projects''' tab, and choose '''New > Project...''' and in the window choose '''Standard Make C++ Project.'''

Give the project a name, and uncheck the '''Use default location''' box. You must give the location that you checked the code out into here.

At this point, you will be able to use TortoiseSVN or Subclipse within Eclipse to control the source.

== Building ==

'''NOTE FOR LINUX USERS''' For building, you can probably get away with running './autogen.sh' then './configure' from the directory containing your copy of the repository. You can then create a 'Builder' which contains Makefile as Main-Location.

Be sure you have the btool built and ready to go, as outlined on the [[Win32Port]] page. You can build Inkscape from the command line or initiate it from within Eclipse, which will capture the output for you.

To set up Eclipse to do this, make sure you are in the '''C/C++ Perspective''' and that your project is open. Right click on the project name and click '''Properties'''. Click on '''Builders'''. Uncheck any builders that are there since we will be using the custom btool. Click '''New...''' and select '''Program'''.

[[Image:Eclipse-04.png]]

In the '''Main''' tab, browse the workspace for the location of the btool.exe file. Browse the workspace again to set the working directory to the main project directory.

[[Image:Eclipse-05.png]]

Now go to the '''Environment Tab''' and add a new variable called path. Add the same thing that appears in your mingenv.bat file here.

[[Image:Eclipse-06.png]]

[[Image:Eclipse-07.png]]

Click on '''C/C++ Project Paths''' and then the tab '''Path Containers'''. Click '''Add...''', choose '''Discovered scanner configuration container''', '''Next''', '''Discovered Paths''', and '''Finish'''.

Now go to '''C/C++ Include Paths and Symbols'''. Click '''Add Contributed''' and choose the '''Discovered scanner configuration container''', then '''Discovered Paths'''. Then click '''Add External Include Path''' and add the path to your GTK folder (probably something like c:\gtk210).

[[Image:Eclipse-08.png]]

You should now be able to use the '''Project > Build All''' command, capturing the output onto Eclipse's console.

== Debugging ==

You need to make a couple of changes to the build.xml file and do a clean rebuild. First, add -g to the flags section:

<flags>
-Wall -O3
-mms-bitfields
'''-g'''
</flags>

Then avoid stripping symbol information from the exe by changing this line
strip="'''true'''" symfile="${build}/inkscape.dbg"
with this one
strip="'''false'''" symfile="${build}/inkscape.dbg"

Now you need to create a debugging instance in Eclipse. Click '''Run > Debug...'''. Click on '''C/C++ Local Application''' and then click the new button. Give the launch configuration a logical name such as Inkscape Debug.

These screenshots show you the values you have to change in each tab. Nothing else needs to change.

[[Image:Eclipse-09.png]]

[[Image:Eclipse-10.png]]

Now you can launch this new configuration and debug away!

(Don't worry about funny warnings about files or folders not existing - it doesn't seem to affect the use of the debugger. However, if you know how to fix it, please replace this comment with instructions.)

[[Category:Developer Documentation]]

Using Eclipse

2015-03-04T02:14:36Z

BitBarrel: minor formatting

'''Note:''' The instructions in this wiki are out of date and do not work anymore. This page is just a reference as it might provide you with a clue on how to get it to work. If you manage to get compiling and debugging to work under Windows using Eclipse, please modify this page accordingly.

Eclipse is a popular development tool used primarily with Java; however, C/C++ development can also be done. This page will help you set up Eclipse for coding, building, and debugging Inkscape.

= Eclipse on Fedora =

# Follow the ''Installation'' and ''Configuration'' steps of guide [http://wiki.bazaar.canaonical.com/BzrEclipse BzrEclipse] but be carefull:
#* At this moment, this How to is for a previous version of Eclipse (some dialogs and menus have changed)
#* ''bzr-xmloutput'' must be decompress in a folder named exactly ''xmloutput'' in Bazaar plugins directory

= Setup project in Eclipse =

Following steps are equivalent to:

checkout lp:inkscape /home/{USER_NAME}/workspace/Inkscape

In Eclipse:

# File > New > Project...
# Select Bazaar > Checkout as a new project
# Select ''Initialize a new branch location''
# Set ''Branch location'' to ''lp:inkscape''
# Select ''Create a project''
# Set ''Project name'' to ''Inkscape''

After quite a long time working, the Inkscape project appears in the Eclipse Explorer.

= Eclipse on Windows =

Running Eclipse provides a relatively easy and familiar way to work with Inkscape code on Windows. This section will explain how to make it happen.

'''Note:''' Some of these instructions may be applicable to development on Mac or Linux. Feel free to refactor them if you are adding information for those platforms.

== Initial Setup ==

First, make sure Inkscape compiles under windows using the command line to verify the source and dependencies are installed correctly. Follow the instructions on the [[Win32Port]] page under the heading '''Inkscape under Windows'''.

If you don't have Eclipse, [http://www.eclipse.org/downloads/ get it]. Check out the [http://help.eclipse.org/help32/index.jsp online help] if needed.

Next, you need to set up the necessary add-ons. Most important is the [http://www.eclipse.org/cdt/downloads.php CDT plug-in] which facilitates C/C++ development. You may also wish to add [http://subclipse.tigris.org/install.html Subclipse] for SVN access within Eclipse. Alternatively, many Windows users prefer to use [http://tortoisesvn.net/downloads TortoiseSVN], which works with Windows Explorer.

== Creating a Project ==

=== Subclipse (Outdated as version control is provided by Bazaar now) ===

The next step is to get the source code ready for use in Eclipse. Check [[WorkingWithSVN | here]] for general instructions for working with SVN; in this section, the aim is to show how to check out the code using Subclipse.

In Eclipse, we want the SVN perspective to be open. Click '''Window > Open Perspective > Other'''. Choose '''SVN Repository Exploring''' and click ok.

[[Image:Eclipse-01.png]]

In the '''SVN Repository''' tab, right click and choose '''New > Repository Location...'''.

[[Image:Eclipse-02.png]]

In the '''Location Url:''' box, paste the link https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk and click finish. This location will now show in the '''SVN Repository''' tab. You can expand the tree to see what is on the server.

Now right click the location name (which is really just the link given above), and click '''Checkout...'''. Choose '''Check out as a project configured using the New Project Wizard''' and the revision you want (probably Head), and click '''Finish'''.

In the New Project window that appears, choose '''C++ Project''' in Eclipse Europa (or in Callisto '''Standard Make C++ Project''') and click '''Next'''.

[[Image:Eclipse-Europa-ProjectType.png]]

Give your project a name such as InkscapeSVN. Uncheck the '''Use default location''' box so you can provide a better project location outside of your workspace, such as C:\InkscapeSVN. Select '''Executable (XL C/C++)''' as the project type, and '''XL C/C++ Tool Chain''' as the the Toolchain (this will not be necessary in Callisto (or before?) as this has been already been specified by selecting '''Standard Make C++ Project'''). Click '''Finish'''.

[[Image:Eclipse-Europa-CppProjectType.png]]

The source code will now be checked out - this may take a while. You will also now have a project in the '''C/C++ Perspective''' with whatever name you provided earlier.

=== TortoiseSVN (Outdated as version control is provided by Bazaar now) ===

To use TortoiseSVN instead of Subclipse to check out your project, open a Windows Explorer instance. Right click anywhere outside of an existing SVN tree and choose '''SVN Checkout...'''. Specify the link given above and the destination directory.

To get a project in Eclipse, go to the '''C/C++ Perspective'''.

In Eclipse Europa select '''File > New > C++ Project'''. Choose a project type of '''Executable (XL C/C++)'''.

In Eclipse Calisto right click in the '''C/C++ Projects''' tab, and choose '''New > Project...''' and in the window choose '''Standard Make C++ Project.'''

Give the project a name, and uncheck the '''Use default location''' box. You must give the location that you checked the code out into here.

At this point, you will be able to use TortoiseSVN or Subclipse within Eclipse to control the source.

== Building ==

'''NOTE FOR LINUX USERS''' For building, you can probably get away with running './autogen.sh' then './configure' from the directory containing your copy of the repository. You can then create a 'Builder' which contains Makefile as Main-Location.

Be sure you have the btool built and ready to go, as outlined on the [[Win32Port]] page. You can build Inkscape from the command line or initiate it from within Eclipse, which will capture the output for you.

To set up Eclipse to do this, make sure you are in the '''C/C++ Perspective''' and that your project is open. Right click on the project name and click '''Properties'''. Click on '''Builders'''. Uncheck any builders that are there since we will be using the custom btool. Click '''New...''' and select '''Program'''.

[[Image:Eclipse-04.png]]

In the '''Main''' tab, browse the workspace for the location of the btool.exe file. Browse the workspace again to set the working directory to the main project directory.

[[Image:Eclipse-05.png]]

Now go to the '''Environment Tab''' and add a new variable called path. Add the same thing that appears in your mingenv.bat file here.

[[Image:Eclipse-06.png]]

[[Image:Eclipse-07.png]]

Click on '''C/C++ Project Paths''' and then the tab '''Path Containers'''. Click '''Add...''', choose '''Discovered scanner configuration container''', '''Next''', '''Discovered Paths''', and '''Finish'''.

Now go to '''C/C++ Include Paths and Symbols'''. Click '''Add Contributed''' and choose the '''Discovered scanner configuration container''', then '''Discovered Paths'''. Then click '''Add External Include Path''' and add the path to your GTK folder (probably something like c:\gtk210).

[[Image:Eclipse-08.png]]

You should now be able to use the '''Project > Build All''' command, capturing the output onto Eclipse's console.

== Debugging ==

You need to make a couple of changes to the build.xml file and do a clean rebuild. First, add -g to the flags section:

<flags>
-Wall -O3
-mms-bitfields
'''-g'''
</flags>

Then avoid stripping symbol information from the exe by changing this line
strip="'''true'''" symfile="${build}/inkscape.dbg"
with this one
strip="'''false'''" symfile="${build}/inkscape.dbg"

Now you need to create a debugging instance in Eclipse. Click '''Run > Debug...'''. Click on '''C/C++ Local Application''' and then click the new button. Give the launch configuration a logical name such as Inkscape Debug.

These screenshots show you the values you have to change in each tab. Nothing else needs to change.

[[Image:Eclipse-09.png]]

[[Image:Eclipse-10.png]]

Now you can launch this new configuration and debug away!

(Don't worry about funny warnings about files or folders not existing - it doesn't seem to affect the use of the debugger. However, if you know how to fix it, please replace this comment with instructions.)

[[Category:Developer Documentation]]

Extension repository

2015-02-26T02:10:08Z

BitBarrel: /* Scale Generator */

It would be very useful to have a central Internet repository for Inkscape extensions, in a similar manner to Firefox. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension was updated.

== Extensions ==

===[[ExtrudeEffect]]===
Extrude polygons to "3d", also make "string art".

===[http://wiki.colivre.net/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript]===
Creating calendars sucks or is impractical if you do not have something that automates the process of putting the days organized in blocks of months for you. To format manually is easy, but this extension can help you on this, too. BASH script, works for Win32 with Cygwin.

===[http://wiki.colivre.net/Aurium/InkscapeAreaCuter InkscapeAreaCutter]===
For web designers. Slice your site design into .png images. (pt_BR)

===[http://www.julienvitard.eu/ EQTeXSVG]===
Convert an inline LATEX equation into SVG path using Python.

===[http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX]===
Insert LaTeX text or equations into Inkscape.

===[http://www.iki.fi/pav/software/textext/ TexText]===
Embed re-editable LaTeX objects into SVG drawings.

===[http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform]===
Bend a path according to another one.
N.B. This extension was added to Inkscape 0.45 as "Pattern along Path".

===[http://www.inkbar.lineaire.net/ InkBar]===
Create EAN13 bar codes.

===[http://technoargia.free.fr/swftools/ SWF output]===
Save drawings as SWF. Updated version (compatible with Inkscape 0.48) ist available on [https://gist.github.com/frederik-elwert/1a46f82fce5d3deb7842 GitHub].

===[http://wiki.colivre.net/Aurium/Puff Puff]===
Fluffs elements! :D

===[http://www.colivre.coop.br/Aurium/InkSudoku Sudoku Generator]===
Generates a Sudoku square with its solution (''in a small square if you want'').

===[[CalligraphedOutlineFill]]===
Helps to fill in the inside area of shapes drawn with the Calligraphy tool.

===[http://edlab.die.unipd.it/Site4.html SlotStar]===
Helps to draw the star of slot of a winding of an electrical machine

===[http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension]===
Extract text in an SVG drawing to a LaTeX picture environment.

===[http://saws.googlecode.com s.a.w.s]===
Export an SVG as valid XHTML/CSS files.

===[http://www.colivre.coop.br/Aurium/InkscapeGenerator Generator]===
Replace text and data to automatically generate files (as PDF, PS, JPG, etc...), based on an SVG template and a data file. ''e.g.'', a CSV file

===[http://code.google.com/p/inkscape2tikz/ TikZ exporter]===
Export SVG paths as TikZ/PGF code for use with LaTeX.

===[[FindMatch]]===
Looks for paths that match the selected path and places all matches on the same layer.

===[http://emilien.tlapale.com/code/inksyntax InkSyntax]===
A source code syntax highlighter plugin for Inkscape (wrapping [http://pygments.org pygments] and [http://www.andre-simon.de/doku/highlight/en/highlight.html highlight]).

===[http://sites.google.com/site/placeonpath/ Place Objects on Path]===
Places objects on a curve. The curve is the object that has the lowest z-order (and which must be a path). Distances between objects remain the same as they were before placing. If objects can't be placed on the curve because of their distances they are left in place. Objects will not be modified; clones are allowed. Arrange distances between your objects manually first as curve position and direction.

===[http://code.google.com/p/jessyink/ JessyInk]===
A collection of Javascripts that can be embedded into an SVG file to produce slide shows on opening in a browser. Current releases of JessyInk include a number of inkscape extensions to assign effects, transitions and other aspects of the presentations.

===[http://svg2dxf.googlecode.com/files/svg2dxf_inkscape.zip svg2dxf]===
Updated version of [http://www.bobcookdev.com/inkscape/inkscape-dxf.html Better Better DXF output] which adds support for polylines and does not overwrite the default inkscape simpletransform.py. See README if getting lxml xpath errors.

===[http://code.google.com/p/pixelsnap/ PixelSnap]===
Tool for aligning object/paths onto the pixel grid for bitmap export.

===[http://code.google.com/p/inkscape-guides-creator/ Guide creator]===
Creates multiple guides at once, at set intervals.

===[http://code.google.com/p/inkscapescalegenerator/ Scale Generator]===
Create a scale for a ruler, map, gauge, clock, compass, etc.

===[http://code.google.com/p/scott-inkscape/wiki/SevenSegmentDigits Seven Segment Digits]===
Create calculator style digits.

===[http://www.cnc-club.ru/forum/viewtopic.php?f=15&t=37&p=92 Close curves]===
Closes all open paths in the selection.

===[http://www.cnc-club.ru/forum/viewtopic.php?f=15&p=101 Gcode tools]===
Generates Gcode program (used in CNC machinery) from given paths.

===[http://dp48069596.lolipop.jp/inkscape_script.html Closeoff, Scatterpath, Selection, Zigzag and Netting]===
See [http://dp48069596.lolipop.jp/inkscape_video.html] for how to use Zigzag and scater extensions.

===[http://wiki.xmoto.tuxfamily.org/index.php?title=How_to_create_smooth_levels_using_Inkscape Inksmoto]===
Level editor for the Xmoto game.

===[http://www.cnc-club.ru/forum/viewtopic.php?f=33&t=37 Close Curves]===
Extension to close the paths in the selection, useful for importing filled paths into openoffice.

===[http://kalyaev.com/2010/20100423/gcodetools.html gcodetools]===
Gcodetools is a plug-in for Inkscape. It prepares and converts paths from Inkscape to Gcode, using biarc interpolation. for use with CNC milling machines.

===[http://www.signcutpro.com/SignCut-Productivity-Pro/signcut-export-plugins.html SignCut Export]===
Set of extensions that come with SignCut to enable Inkscape users to use plotters / cutters via the SignCut software.

===[http://www.lysator.liu.se/~perni/iboardgameexts/ Boardgame extensions]===
Inkscape Extensions for Boardgame Developlemt [http://www.boardgamegeek.com/thread/299033/inkscape-extensions-for-boardgame-developlemt 1]. Includes a hexagonal board/hexmap creator and tools to sheets of tiles for counters ect.

===[http://camm-gl.dyndns.org/ Inkscape CAMM-GL Extension]===
... vinyl cutting utility for Inkscape

This program is basically just a cut manager. Create artwork in Inkscape, save with the supplied hpgl_output extension, and cut or plot with this program. The program does provide some useful functions, but it is by no means a fully featured solution. I do use it exclusivly, and it currently satisfies my needs.

===[http://salug.it/~fabioviola/inkscape/extensions Badge Renderer]===
... A little script to render a badge in a Inkscape document.
This is only a little python script used as example in an article for my GLUG (SaLUG!) journal. This can be used to quickly render a badge. It can be improved, for example, with shadow direction and reflex direction. As soon as possible I'll do it.

===[http://www.craigmarshall.org/archives/8 Guillotine]===
This is a mirror of the GIMP guillotine function, it allows you to drag guides onto the canvas, and then using Export->Guillotine, export those slices as pngs to the directory and filename of your choice. It also has an option for using export hints, if your drawing has previously been exported. [http://www.inkscapeforum.com/viewtopic.php?f=11&t=5832 Forum link]

===[http://code.google.com/p/inkscape-replace-font/ Replace Font]===
Allows mass replacement of the fonts in a document. Can list existing fonts. [http://www.inkscapeforum.com/viewtopic.php?f=11&t=5843 Forum link]

=== [http://sozi.baierouge.fr/wiki/doku.php?id=en:welcome Sozi] ===
A tool for presentations made using zooms and rotations, not just slides. Uses Javascript added to the .svg file to display in web-browsers.

Version 13.11 is the last version of sozi which is available as an Inkscape extension. According to [http://sozi.baierouge.fr/release-14.10.html this article], future versions will be available as standalone-application.

===[http://www.inkscapeforum.com/viewtopic.php?f=11&t=5943 CMYK pdf/tiff export]===
Extension to export to CYMK colourspaced PDFs / Tiffs. In development (september 2010)

===[http://sourceforge.net/projects/o-scape/ O-Scape; Orienteering map making tools]===
Extensions to help make Orienteering maps; see this [http://www.nopesport.com/news/1343-o-scape-free-orienteering-mapping-software interview] for more information

===[http://www.inkscapeforum.com/viewtopic.php?f=5&t=4729#p32019 Mirror]===
Mirror a path along any axis.

===[http://sourceforge.net/projects/inkscape-tables/ Tables in Inkscape]===
Adds (experimental?) table suport as an extension.

===[http://doctormo.org/2011/05/19/deviantart-plugins-released/ deviantArt uploaders]===
Upload artwork to deviantArt from the "publish to" menue item under extensions.

===[http://code.google.com/p/inkscape-music-scale-generator/ Musical scales]===
Extension for automatic generation schemes of musical scale and chords on piano.

===[http://www.inkscapeforum.com/viewtopic.php?f=11&t=9212 Text from CSV]===
Extension to enter text from a CSV file

===[http://luther.ceplovi.cz/git/inkscape-ungroup-deep.git/ Deep Ungroup]===
Ungroup all groups in the selected object.

===[http://www.pernsteiner.org/inkscape/layerclip/ Layer Clip]===
This is a a set of Inkscape extension scripts for setting and removing clip paths for entire layers. Inkscape has no trouble rendering or editing layers with clip paths, but it currently has no built-in method of setting the clip path for a layer, this is the purpose of these extensions.

Features include: Clip containing layer, Clip layer above, Clip layer below, Clip parent layer.

'''''Notes:'''
''You must select an object in the clipping layer before applying the extension, otherwise you will receive an error message.
It is a good idea to lock the layer after the extension has been applied. You may also require hiding the clipping layer when using "Clip layer below". This may be exploited to create a masking layer.
Tested on Inkscape 0.48.2 r98''19''

===[https://bitbucket.org/daviddamerell/inkscapesaveasicoextension Icon Generation]===
This is an Inkscape output extension that adds an option to the "save-as" dialog box to generate Windows Icon files (*.ico).

==Extensions for Programmers:==
===[http://wiki.colivre.net/Aurium/RubyInk RubyInk]===
Inkscape extension with Ruby

===[http://wiki.colivre.net/Aurium/InkBash Ink-Bash]===
<nowiki>ShellScript</nowiki> Forever!

===[http://wiki.colivre.net/Aurium/InkMoz InkMoz]===
The Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

== The Repository Specification ==

A website where programmers can publish their extensions, users can search by that, and an update program can access this updates.

=== The Website ===

Must Have:
* '''User Registration''': to allow upload, votes and comments
* '''Extension Validation''': when published, it is public, but the user must be notified that was not validated (the code must be viewed by an validator user). The software updater do not update non-validated versions.
** '''Validation Feedback''': the validator user must write why the extension was not validated.
** '''Extension Deletion''': the validator user can delete an extension or version when he found a malicious code. The upload user must be marked as a malicious user and the account must be blocked.
* '''Extension Search''': with filter, by any available data.
* '''User Votes and Comments for Extensions''': The user can vote and/or comment an extension version.
* '''Extension Bug-Tracker''': today, third part extensions are in simple web-pages. The site may have a Bug-Traker to help all little scripts.
* '''User Extensions Requests''': a lot of users have ideas. Here is a good place for programmers see and make that alive.
* '''Host a cool page for the extension''': allow introduction text, documenbtation, screenshots, examples, and '''i18n'''!
* '''Help the l10n of this extensions''': with a web interface, like pootle and provide the l10n file for the updater program.
* '''Provide Version Control''': A SVN account will be cool, but web uploads (by web-forms) can be transparently SVN commits.

=== The Extension Meta-Data ===

''The data in INX file and more some, like the OS and Inkscape version compatibility...''

The INX file will define the meta-data settable by that. If some extension uses multiples INX files to have more than one option in the menu, all INX files must be read to set the meta-data. The meta-data will be cached in a database to help the search. The DB only need the meta-data of the last validated version and the last non-validated (if that is newer).

=== The Update Program ===

* '''Search for New Extensions''': when the user request
* '''Update Extensions''': search for updates and install that
* '''Help the Code Validation''': for advanced users. Show the extension code and the diff if is that an update.
* '''Help the User Bug-Reporting''': that is not working! The user must say now! ''(When the Update Program be part of the Inkscape, the error window can have a button to submit a bug-report)''
* '''Must test the extension dependencies''': the user must know what is needed to install before try to use.

== Name Proposal ==

Propose a name for the Inkscape Extension Repository:

* '''The Factory'''
* '''Extension Factory'''
* '''INX Factory'''

''Why Factory? Because it is not only a repository. ;-)''

* '''The Furnace'''
''Because Fire & Coal (Passion & Knowledge) are your tools for creating the extensions''

[[Category:Developer Documentation]]
[[Category:Extensions]]

== Mockups ==

Here are some suggestions for what an extension repository might look like.

<gallery>
File:Extension_repository_-_homepage.png|The home page.
File:Extension_repository_-_extension_page.png|The page for an individual extension.
File:Extension_repository_-_request_page.png|The page for an individual request.
File:Extension_repository_-_search_page.png|The search form page.
File:Extension_repository_-_search_results.png|The search results page.
File:Extension_repository_-_submit_extension.png|The extension submission page.
File:Extension_repository_-_submit_request.png|The request submission page.
File:Extension_repository_-_requests.png|The main requests page.
</gallery>

I have no idea of the detail of this project; I don't currently have the skills necessary to try implementing it. I'm also not sure whether it's a good idea for Inkscape to offer hosted repositories (using [http://www.redmine.org/projects/redmine Redmine] or [http://trac.edgewall.org/ Trac]?) or whether it would be better to just leave it to the developer to use somewhere like [http://github.com/ GitHub] or [http://bitbucket.org/ BitBucket] and then use their APIs to pull some basic data onto the site. [[User:Legio noctis|Legio noctis]] 10:19, 23 May 2010 (UTC)

Using Eclipse

2015-02-20T08:05:40Z

BitBarrel: Out of date information note added

Eclipse is a popular development tool used primarily with Java; however, with the CDT plugin, C/C++ development can also be done. This page will help you set up Eclipse for coding, building, and debugging Inkscape.

'''Note:''' The instructions for Windows are out of date and do not work anymore. If you manage to get compiling and debugging to work under Windows using Eclipse, please modify this page accordingly.

= Eclipse on Fedora =

# Follow the ''Installation'' and ''Configuration'' steps of guide [http://wiki.bazaar.canaonical.com/BzrEclipse BzrEclipse] but be carefull:
#* At this moment, this How to is for a previous version of Eclipse (some dialogs and menus have changed)
#* ''bzr-xmloutput'' must be decompress in a folder named exactly ''xmloutput'' in Bazaar plugins directory

= Setup project in Eclipse =

Following steps are equivalent to:

checkout lp:inkscape /home/{USER_NAME}/workspace/Inkscape

In Eclipse:

# File > New > Project...
# Select Bazaar > Checkout as a new project
# Select ''Initialize a new branch location''
# Set ''Branch location'' to ''lp:inkscape''
# Select ''Create a project''
# Set ''Project name'' to ''Inkscape''

After quite a long time working, the Inkscape project appears in the Eclipse Explorer.

= Eclipse on Windows =

Running Eclipse provides a relatively easy and familiar way to work with Inkscape code on Windows. This section will explain how to make it happen.

'''Note:''' Some of these instructions may be applicable to development on Mac or Linux. Feel free to refactor them if you are adding information for those platforms.

== Initial Setup ==

First, make sure Inkscape compiles under windows using the command line to verify the source and dependencies are installed correctly. Follow the instructions on the [[Win32Port]] page under the heading '''Inkscape under Windows'''.

If you don't have Eclipse, [http://www.eclipse.org/downloads/ get it]. Check out the [http://help.eclipse.org/help32/index.jsp online help] if needed.

Next, you need to set up the necessary add-ons. Most important is the [http://www.eclipse.org/cdt/downloads.php CDT plug-in] which facilitates C/C++ development. You may also wish to add [http://subclipse.tigris.org/install.html Subclipse] for SVN access within Eclipse. Alternatively, many Windows users prefer to use [http://tortoisesvn.net/downloads TortoiseSVN], which works with Windows Explorer.

== Creating a Project ==

=== Subclipse (Outdated as version control is provided by Bazaar now) ===

The next step is to get the source code ready for use in Eclipse. Check [[WorkingWithSVN | here]] for general instructions for working with SVN; in this section, the aim is to show how to check out the code using Subclipse.

In Eclipse, we want the SVN perspective to be open. Click '''Window > Open Perspective > Other'''. Choose '''SVN Repository Exploring''' and click ok.

[[Image:Eclipse-01.png]]

In the '''SVN Repository''' tab, right click and choose '''New > Repository Location...'''.

[[Image:Eclipse-02.png]]

In the '''Location Url:''' box, paste the link https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk and click finish. This location will now show in the '''SVN Repository''' tab. You can expand the tree to see what is on the server.

Now right click the location name (which is really just the link given above), and click '''Checkout...'''. Choose '''Check out as a project configured using the New Project Wizard''' and the revision you want (probably Head), and click '''Finish'''.

In the New Project window that appears, choose '''C++ Project''' in Eclipse Europa (or in Callisto '''Standard Make C++ Project''') and click '''Next'''.

[[Image:Eclipse-Europa-ProjectType.png]]

Give your project a name such as InkscapeSVN. Uncheck the '''Use default location''' box so you can provide a better project location outside of your workspace, such as C:\InkscapeSVN. Select '''Executable (XL C/C++)''' as the project type, and '''XL C/C++ Tool Chain''' as the the Toolchain (this will not be necessary in Callisto (or before?) as this has been already been specified by selecting '''Standard Make C++ Project'''). Click '''Finish'''.

[[Image:Eclipse-Europa-CppProjectType.png]]

The source code will now be checked out - this may take a while. You will also now have a project in the '''C/C++ Perspective''' with whatever name you provided earlier.

=== TortoiseSVN (Outdated as version control is provided by Bazaar now) ===

To use TortoiseSVN instead of Subclipse to check out your project, open a Windows Explorer instance. Right click anywhere outside of an existing SVN tree and choose '''SVN Checkout...'''. Specify the link given above and the destination directory.

To get a project in Eclipse, go to the '''C/C++ Perspective'''.

In Eclipse Europa select '''File > New > C++ Project'''. Choose a project type of '''Executable (XL C/C++)'''.

In Eclipse Calisto right click in the '''C/C++ Projects''' tab, and choose '''New > Project...''' and in the window choose '''Standard Make C++ Project.'''

Give the project a name, and uncheck the '''Use default location''' box. You must give the location that you checked the code out into here.

At this point, you will be able to use TortoiseSVN or Subclipse within Eclipse to control the source.

== Building ==

'''NOTE FOR LINUX USERS''' For building, you can probably get away with running './autogen.sh' then './configure' from the directory containing your copy of the repository. You can then create a 'Builder' which contains Makefile as Main-Location.

Be sure you have the btool built and ready to go, as outlined on the [[Win32Port]] page. You can build Inkscape from the command line or initiate it from within Eclipse, which will capture the output for you.

To set up Eclipse to do this, make sure you are in the '''C/C++ Perspective''' and that your project is open. Right click on the project name and click '''Properties'''. Click on '''Builders'''. Uncheck any builders that are there since we will be using the custom btool. Click '''New...''' and select '''Program'''.

[[Image:Eclipse-04.png]]

In the '''Main''' tab, browse the workspace for the location of the btool.exe file. Browse the workspace again to set the working directory to the main project directory.

[[Image:Eclipse-05.png]]

Now go to the '''Environment Tab''' and add a new variable called path. Add the same thing that appears in your mingenv.bat file here.

[[Image:Eclipse-06.png]]

[[Image:Eclipse-07.png]]

Click on '''C/C++ Project Paths''' and then the tab '''Path Containers'''. Click '''Add...''', choose '''Discovered scanner configuration container''', '''Next''', '''Discovered Paths''', and '''Finish'''.

Now go to '''C/C++ Include Paths and Symbols'''. Click '''Add Contributed''' and choose the '''Discovered scanner configuration container''', then '''Discovered Paths'''. Then click '''Add External Include Path''' and add the path to your GTK folder (probably something like c:\gtk210).

[[Image:Eclipse-08.png]]

You should now be able to use the '''Project > Build All''' command, capturing the output onto Eclipse's console.

== Debugging ==

You need to make a couple of changes to the build.xml file and do a clean rebuild. First, add -g to the flags section:

<flags>
-Wall -O3
-mms-bitfields
'''-g'''
</flags>

Then avoid stripping symbol information from the exe by changing this line
strip="'''true'''" symfile="${build}/inkscape.dbg"
with this one
strip="'''false'''" symfile="${build}/inkscape.dbg"

Now you need to create a debugging instance in Eclipse. Click '''Run > Debug...'''. Click on '''C/C++ Local Application''' and then click the new button. Give the launch configuration a logical name such as Inkscape Debug.

These screenshots show you the values you have to change in each tab. Nothing else needs to change.

[[Image:Eclipse-09.png]]

[[Image:Eclipse-10.png]]

Now you can launch this new configuration and debug away!

(Don't worry about funny warnings about files or folders not existing - it doesn't seem to affect the use of the debugger. However, if you know how to fix it, please replace this comment with instructions.)

[[Category:Developer Documentation]]