Group:LibreDWG - LibrePlanet

Group:LibreDWG - LibrePlanet
Navigation menu
About
About LibrePlanet
Mission Statement
Founding documents
Support this Community
Code of Conduct
Anti-harassment policy
Teams
Activists
Wiki Helpers
LibrePlanet Artists
FSF Community Team
Local & Student Teams
Conferences
LibrePlanet Conference
Non-official
Get involved
Participate
Discussion channels
Events
Group:
LibreDWG
From LibrePlanet
(Redirected from
LibreDWG
Jump to:
Welcome the
GNU LibreDWG hackers' wiki
. For general information about the project, please check the
official website
This wiki is mainly intended to help developers or advanced users checkout the latest source code, compile, test, modify and submit changes to LibreDWG. Feel free to contribute to this page. If you are creating a new page, please put it under the LibreDWG tree, eg.
LibreDWG's source code and administrative tools (mailing lists, bug, patch and support trackers) are hosted at
Savannah
. We ask contributors to
create a new user account
and log in prior to submitting tracker items (one could submit bugs anonymously, though). You don't need to join the LibreDWG Savannah group in order to submit bug reports or patches. Please don't do this unless you are instructed to.
Anyone who wants to use or test LibreDWG will have to checkout from the git repository and build from source.
There are several early source and binary preview releases on the github release page:
Contents
Checking out
Dependencies
Building
Testing
Hacking and submitting patches
5.1
Roadmap
5.2
DWG versions
5.3
Bindings and extensions
5.4
Error codes
5.5
Testing Suite
5.5.1
Questions
5.6
AutoCAD
5.7
Google Summer of Code
Git push access
Who uses it?
Talking to us
Checking out
The source code is hosted in a git repository. Check out
git's website
if you don't know what git is (hint:
sudo apt-get install git-core git
). To check out as an anonymous user:
git clone git://git.sv.gnu.org/libredwg.git
There's also a github and gitlab mirror.
Dependencies
You need basic development tools (gcc, autoconf and libtool to compile libredwg. In debian-like distributions, install the
build-essential
autoconf
and
libtool
packages).
Other packages optionally needed:
SWIG
1.7 or later. version 3 preferred.
TeXinfo
Python development headers (debian: python-dev yum: python-devel)
pcre2 (optional, for dwggrep, the pcre2-8 and pcre2-16 libraries)
libps (optional, for dwg2ps)
Perl for the perl bindings
dejagnu (for test/tescases)
Building
cd to the
libredwg
folder created by git, and run the following commands in a terminal:
sh autogen.sh
./configure --enable-trace (this will enable debugging messages)
make
make check
sudo make install
These commands will, respectively, build and configure the building environment, compile the library's source code, install it to /usr/local and compile the tests, programs, examples. If you get any errors, please contact us through the
mailing list
If you want to build under an OS made in Redmond, check
LibreDWG/BuildingWithCygwin
and the appveyor and msys2 recipes From user reports, we know that LibreDWG builds and run correctly in the following CPU architectures:
x86
x86_64
(intel) and
ppc
(older macbooks). If you are able to build and run it in successfully (or not) in other architectures, let us know. For r2007 there are still some big-endian portability issues.
Testing
LibreDWG comes with several testsuites, programs and examples that can be used for testing purposes. The most advanced examples are dwg2dxf and dwgrewrite.
make check
programs/dwgread -v4 yourdwgfile.dwg
If you get any errors (specially segfaults) and want to
submit a bug
, please attach a file with your output. To redirect all output, including stderr to a file:
programs/dwgread -v4 yourdwgfile.dwg 2&> test.out
If possible,
add a link
to the tested DWG file to the submission. We can't do much if we can't access the file. Don't attach DWG files to the submission, specially if you don't have copy rights over them. We collect
links to available DWG
files for testing, please keep them updated.
We are building a
test suite
Hacking and submitting patches
You are welcome to get your hands dirty and put down some code. Although, you should be aware of some details:
Please follow the
GNU Coding Standards
, specially the GNU identation style.
Be aware that the copyright over your work will need to be assinged to the Free Software Foundation. If it is a small contribution, you won't need to sign any papers. We have decided this because the FSF will enforce the GPL for the program if someone violates it, and will act juridically if necessary. Although, you still get the credit for your work.
You'll probably need to understand the internals of the DWG format. The Open Design Alliance provides a
reverse-engineered DWG specification
Please be sure to work on the latest revision. Run
git pull
from time to time and before generating patches.
After your changes are done and well tested, generate a patch with format-patch:
checkout a working copy as described above. cd to the directory where the source code is, and then
git config --global user.name "Your Name Comes Here"
git config --global user.email you@yourdomain.example.com

(compile, edit, test)
git add
git commit
(please format your commit message as described in the HACKING file)

(compile, edit, test)
git commit...

git format-patch origin
The
git format-patch
command will generate one patch for each commit (don't hesitate making various commits if you are working on different subjects/tasks).
Don't send patches to the mailing list!
Submit each patch separately to the
patch tracker
If you are not very familiar with git, check the
git documentation
. You have to run "git config" only once. This will configure git to make your name and email appear on your commits.
For further information, please read the HACKING file in the root of the source tree.
If you don't know how/where to start working, please read the following items:
Roadmap
This is a rough development roadmap:
v0.4 - entity and object parsing (read-only)
v0.5 through v1.0 - API and bindings, that is, bindings to languages such as Python and C++, plus a reasonable API, which won't exclude the direct struct access if the user wishes.
v2.0 - encode support
We are actually working on all of them, but the earlier milestones seem more feasible. The first beta release 0.6 will be in 2018.
DWG versions
Currently we support all R13 - R2018 DWG versions. R11 and earlier is under construction.
Some object and class layouts are under construction, but LibreDWG has the best DWG support of all free DWG libraries.
Bindings and extensions
Python (2 and 3) and perl5 bindings have been generated with SWIG. Patches for other language bindings are accepted.
The generated swig .c code is quite huge, so it's strongly advised to use ccache (CC='ccache cc') for your compiler. It can last a few minutes the very first time and on every change to the API.
The GNU project guidelines encourage developers to use
guile
as an extension framework. Guile uses LISP as an extension language. DWG is an extensible format: people can write custom entities, and we should provide some plugin feature that allows people to write custom code do interpret them.
Error codes
Any C library should, ideally, have no stdout/stderr output and communicate errors to the application through error codes.
Testing Suite
We have an automated
test suite
to make it easy to verify and ensure that code changes won't break the DWG parser. It also allows users to test the library with their own files in an easy way. The first step is gathering a collection of DWG files "Saved as..." to various DWG versions. These files must be released to the public domain.
Questions
Where are we going to upload large files to : archive.org?
How are we going to convert them in many formats, we need someone with a autocad converter software.
We should be recycling test cases from other cad software, from svg and inkscape.
We should be publishing profiles of code coverage for each test.
We should be marking up some document that contains the elements that we have seen so far.
AutoCAD
If you can't program, but have some understanding of AutoCAD, you could help us. Several developers haven't ever used AutoCAD or any other mainstream CAD program, and we usually have difficulties understanding the
semantics
of DWG (how does an aligned dimension look like?), despite being almost experts regarding the low level file
syntax
See
Group:LibreDWG/DWG_concepts
Google Summer of Code
The GNU project has been accepted as a mentoring organization in GSoC two times.
Check our special
Summer of Code page
for further information on how to contribute to LibreDWG as a SoC student.
Git push access
We want contributors, and we believe that giving them write access to the git repository means we trust their work and we want them in our team. Therefore, we have a slightly liberal write access policy: if you submit two non-trivial patches and they get accepted, you're in. As stated above, we've assigned the copyright to the Free Software Foundation. So, in order to become an official developer, you'll have to fill the following form and mail it to
fsf-records@gnu.org
and please carbon copy (CC)
libredwg-owner@gnu.org
Please email the following information to fsf-records@gnu.org, and we
will send you the assignment form for your past and future changes.
Please use your full name as the subject line of the message.

[What is the name of the program or package you're contributing to?]
LibreDWG

[Did you copy any files or text written by someone else in these changes?
Even if that material is free software, we need to know about it.]

[Do you have an employer who might have a basis to claim to own
your changes? Do you attend a school which might make such a claim?]

[For the copyright registration, what country are you a citizen of?]

[What year were you born?]

[Please write your email address here.]

[Please write your snail address here.]

[Which files have you changed so far, and which new files have you written
so far?]
Who uses it?
GRASS
- DWG import plugin (v.in.redwg)
PythonCAD
LibreCAD
- LibreCAD developers are experimenting with DWG import filter for their CAD software using LibreDWG.
Talking to us
If you just want to ask a question or give us some ideas, feel free to write to or join the
developers' mailing list
If you just want to be updated about important LibreDWG announcements and releases, join the low traffic
announcements mailing list
Follow the news section at
Savannah
or subscribe to the news
atom feed
for general announcements for developers, contributors and people who want to keep track of our current work and progress.
Developers also hang out at #libredwg on irc.freenode.net, just drop by and say hello.
Happy Hacking!
This page was a
featured resource
in January 2014.
Retrieved from "
The Free Software Foundation (FSF) is a nonprofit with a worldwide mission to promote computer user freedom.
We defend the rights of all software users. (
Campaigns
High Priority Free Software Projects
Free JavaScript
Secure Boot vs Restricted Boot
GNU Operating System
Defective by Design
See all campaigns
Get Involved
Contact
Send your feedback on our translations and new translations of pages to
campaigns@fsf.org
Copyright © 2013–2023
Free Software Foundation
, Inc.
JavaScript license information