Browse Source

Initial commit

tags/0.1.2
tastytea 5 months ago
commit
062e435d8c
Signed by: tastytea <tastytea@tastytea.de> GPG Key ID: CFC39497F1B26E07
11 changed files with 1326 additions and 0 deletions
  1. 176
    0
      .drone.yml
  2. 3
    0
      .gitignore
  3. 47
    0
      CMakeLists.txt
  4. 198
    0
      Doxyfile
  5. 674
    0
      LICENSE
  6. 57
    0
      README.md
  7. 8
    0
      build_doc.sh
  8. 33
    0
      example.cpp
  9. 31
    0
      src/debug.hpp
  10. 45
    0
      src/identiconpp.cpp
  11. 54
    0
      src/identiconpp.hpp

+ 176
- 0
.drone.yml View File

@@ -0,0 +1,176 @@
1
+pipeline:
2
+  gcc5:
3
+    image: debian:stretch-slim
4
+    pull: true
5
+    when:
6
+      event: [push, pull_request]
7
+    environment:
8
+      - LANG=C.utf8
9
+      - CXX=g++-5
10
+      - CXXFLAGS=-pipe -O2
11
+    commands:
12
+      - rm /etc/apt/apt.conf.d/docker-clean
13
+      - apt-get update -q
14
+      - echo "APT::Default-Release \"stretch\";" >> /etc/apt/apt.conf.d/00default_release
15
+      - echo "deb http://ppa.launchpad.net/ubuntu-toolchain-r/test/ubuntu xenial main" >> /etc/apt/sources.list.d/ubuntu-toolchain-r.list
16
+      - apt-get install -qy gnupg
17
+      - gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 0x60c317803a41ba51845e371a1e9377a2ba9ef27f
18
+      - gpg --armor --export 0x60c317803a41ba51845e371a1e9377a2ba9ef27f | apt-key add -
19
+      - apt-get update -q
20
+      - apt-get install -qy -t xenial g++-5
21
+      - apt-get install -qy cmake pkg-config
22
+      - apt-get install -qy libcrypto++-dev libmagick++-dev
23
+      - rm -rf build && mkdir -p build && cd build
24
+      - cmake -DCMAKE_INSTALL_PREFIX=/usr ..
25
+      - make VERBOSE=1
26
+    volumes:
27
+      - /var/cache/debian-package-cache:/var/cache/apt/archives
28
+
29
+  gcc6:
30
+    image: debian:stretch-slim
31
+    pull: true
32
+    environment:
33
+      - LANG=C.utf8
34
+      - CXX=g++-6
35
+      - CXXFLAGS=-pipe -O2
36
+    commands:
37
+      - rm /etc/apt/apt.conf.d/docker-clean
38
+      - apt-get update -q
39
+      - apt-get install -qy g++-6 cmake pkg-config
40
+      - apt-get install -qy libcrypto++-dev libmagick++-dev
41
+      - apt-get install -qy dpkg-dev d-shlibs rpm file wget
42
+      - gpg --no-tty --import /var/autosign_gpg.key
43
+      - rm -rf build && mkdir -p build && cd build
44
+      - cmake -DCMAKE_INSTALL_PREFIX=/usr ..
45
+      - make VERBOSE=1
46
+      - make install DESTDIR=install
47
+      - make package
48
+      - cmake -DWITH_DEB=ON ..
49
+      - make package
50
+      - cmake -DWITH_DEB=OFF -DWITH_RPM=ON ..
51
+      - make package
52
+      - gpg --verbose --detach-sign *.tar.gz
53
+      - gpg --verbose --detach-sign *.deb
54
+      - gpg --verbose --detach-sign *.rpm
55
+    volumes:
56
+      - /var/cache/debian-package-cache:/var/cache/apt/archives
57
+      - /home/tastytea/misc/autosign_gpg.key:/var/autosign_gpg.key
58
+
59
+  gcc7:
60
+    image: debian:stretch-slim
61
+    pull: true
62
+    when:
63
+      event: [push, pull_request]
64
+    environment:
65
+      - LANG=C.utf8
66
+      - CXX=g++-7
67
+      - CXXFLAGS=-pipe -O2
68
+    commands:
69
+      - rm /etc/apt/apt.conf.d/docker-clean
70
+      - apt-get update -q
71
+      - echo "APT::Default-Release \"stretch\";" >> /etc/apt/apt.conf.d/00default_release
72
+      - echo "deb http://ppa.launchpad.net/ubuntu-toolchain-r/test/ubuntu xenial main" >> /etc/apt/sources.list.d/ubuntu-toolchain-r.list
73
+      - apt-get install -qy gnupg
74
+      - gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 0x60c317803a41ba51845e371a1e9377a2ba9ef27f
75
+      - gpg --armor --export 0x60c317803a41ba51845e371a1e9377a2ba9ef27f | apt-key add -
76
+      - apt-get update -q
77
+      - apt-get install -qy -t xenial g++-7
78
+      - apt-get install -qy cmake pkg-config
79
+      - apt-get install -qy libcrypto++-dev libmagick++-dev
80
+      - rm -rf build && mkdir -p build && cd build
81
+      - cmake -DCMAKE_INSTALL_PREFIX=/usr ..
82
+      - make VERBOSE=1
83
+    volumes:
84
+      - /var/cache/debian-package-cache:/var/cache/apt/archives
85
+
86
+  gcc8:
87
+    image: debian:stretch-slim
88
+    pull: true
89
+    when:
90
+      event: [push, pull_request]
91
+    environment:
92
+      - LANG=C.utf8
93
+      - CXX=g++-8
94
+      - CXXFLAGS=-pipe -O2
95
+    commands:
96
+      - rm /etc/apt/apt.conf.d/docker-clean
97
+      - apt-get update -q
98
+      - echo "APT::Default-Release \"stretch\";" >> /etc/apt/apt.conf.d/00default_release
99
+      - echo "deb http://ppa.launchpad.net/ubuntu-toolchain-r/test/ubuntu xenial main" >> /etc/apt/sources.list.d/ubuntu-toolchain-r.list
100
+      - apt-get install -qy gnupg
101
+      - gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 0x60c317803a41ba51845e371a1e9377a2ba9ef27f
102
+      - gpg --armor --export 0x60c317803a41ba51845e371a1e9377a2ba9ef27f | apt-key add -
103
+      - apt-get update -q
104
+      - apt-get install -qy -t xenial g++-8
105
+      - apt-get install -qy cmake pkg-config
106
+      - apt-get install -qy libcrypto++-dev libmagick++-dev
107
+      - rm -rf build && mkdir -p build && cd build
108
+      - cmake -DCMAKE_INSTALL_PREFIX=/usr ..
109
+      - make VERBOSE=1
110
+    volumes:
111
+      - /var/cache/debian-package-cache:/var/cache/apt/archives
112
+
113
+  clang5:
114
+    image: debian:stretch-slim
115
+    pull: true
116
+    when:
117
+      event: [push, pull_request]
118
+    environment:
119
+      - LANG=C.utf8
120
+      - CXX=clang++-5.0
121
+      - CXXFLAGS=-pipe -O2
122
+    commands:
123
+      - rm /etc/apt/apt.conf.d/docker-clean
124
+      - echo "APT::Default-Release \"stretch\";" >> /etc/apt/apt.conf.d/00default_release
125
+      - echo "deb http://deb.debian.org/debian stretch-backports main" >> /etc/apt/sources.list.d/stretch.list
126
+      - apt-get update -q
127
+      - apt-get install -qy -t stretch-backports clang-5.0
128
+      - apt-get install -qy cmake pkg-config
129
+      - apt-get install -qy libcrypto++-dev libmagick++-dev
130
+      - rm -rf build && mkdir -p build && cd build
131
+      - cmake -DCMAKE_INSTALL_PREFIX=/usr ..
132
+      - make VERBOSE=1
133
+    volumes:
134
+      - /var/cache/debian-package-cache:/var/cache/apt/archives
135
+
136
+  clang6:
137
+    image: debian:stretch-slim
138
+    pull: true
139
+    when:
140
+      event: [push, pull_request]
141
+    environment:
142
+      - LANG=C.utf8
143
+      - CXX=clang++-6.0
144
+      - CXXFLAGS=-pipe -O2
145
+    commands:
146
+      - rm /etc/apt/apt.conf.d/docker-clean
147
+      - echo "APT::Default-Release \"stretch\";" >> /etc/apt/apt.conf.d/00default_release
148
+      - echo "deb http://deb.debian.org/debian stretch-backports main" >> /etc/apt/sources.list.d/stretch.list
149
+      - apt-get update -q
150
+      - apt-get install -qy -t stretch-backports clang-6.0
151
+      - apt-get install -qy cmake pkg-config
152
+      - apt-get install -qy libcrypto++-dev libmagick++-dev
153
+      - rm -rf build && mkdir -p build && cd build
154
+      - cmake -DCMAKE_INSTALL_PREFIX=/usr ..
155
+      - make VERBOSE=1
156
+    volumes:
157
+      - /var/cache/debian-package-cache:/var/cache/apt/archives
158
+
159
+  gitea_release:
160
+    image: plugins/gitea-release
161
+    pull: true
162
+    when:
163
+      event: tag
164
+    base_url: https://schlomp.space
165
+    secrets: [ gitea_token ]
166
+    title: ${DRONE_TAG}
167
+    prerelease: true
168
+
169
+  notify:
170
+    image: drillster/drone-email
171
+    pull: true
172
+    host: cryptoparty-celle.de
173
+    secrets: [ email_username, email_password ]
174
+    from: drone@tzend.de
175
+    when:
176
+      status: [ changed, failure ]

+ 3
- 0
.gitignore View File

@@ -0,0 +1,3 @@
1
+/build/
2
+/doc/
3
+/update_doc.sh

+ 47
- 0
CMakeLists.txt View File

@@ -0,0 +1,47 @@
1
+cmake_minimum_required (VERSION 3.2)
2
+project(identiconpp
3
+        VERSION 0.0.0
4
+        LANGUAGES CXX
5
+)
6
+
7
+include(GNUInstallDirs)
8
+find_package(PkgConfig REQUIRED)
9
+pkg_check_modules(MAGICPP REQUIRED Magick++)
10
+pkg_check_modules(LIBCRYPTOPP libcryptopp)
11
+if(NOT LIBCRYPTOPP_FOUND)
12
+    # Debian stretch package installs libcrypto++.pc
13
+    pkg_check_modules(LIBCRYPTOPP REQUIRED libcrypto++)
14
+endif()
15
+
16
+set(CMAKE_CXX_STANDARD 14)
17
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
18
+set(CMAKE_CXX_EXTENSIONS OFF)
19
+
20
+set(CMAKE_CXX_FLAGS_DEBUG
21
+    "${CMAKE_CXX_FLAGS_DEBUG} -Wall -pedantic -Wextra -g -Og -fno-omit-frame-pointer")
22
+if(CMAKE_BUILD_TYPE STREQUAL "Debug")
23
+    add_definitions(-DDEBUG=1)
24
+endif()
25
+
26
+include_directories(${PROJECT_SOURCE_DIR}/src)
27
+include_directories(${PROJECT_BINARY_DIR})
28
+include_directories(${MAGICPP_INCLUDE_DIRS})
29
+include_directories(${LIBCRYPTOPP_INCLUDE_DIRS})
30
+
31
+link_directories(${MAGICPP_LIBRARY_DIRS})
32
+link_directories(${LIBCRYPTOPP_LIBRARY_DIRS})
33
+
34
+file(GLOB sources src/*.cpp)
35
+add_library(${CMAKE_PROJECT_NAME} SHARED "${sources}")
36
+set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES
37
+                      VERSION ${PROJECT_VERSION}
38
+                      SOVERSION ${${CMAKE_PROJECT_NAME}_VERSION_MAJOR})
39
+target_link_libraries(${CMAKE_PROJECT_NAME}
40
+                      "${MAGICPP_LDFLAGS} ${LIBCRYPTOPP_LDFLAGS}")
41
+
42
+add_executable(example "example.cpp")
43
+target_link_libraries(example ${CMAKE_PROJECT_NAME})
44
+
45
+install(TARGETS ${CMAKE_PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_LIBDIR})
46
+install(FILES src/${CMAKE_PROJECT_NAME}.hpp DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
47
+install(FILES README.md DESTINATION ${CMAKE_INSTALL_DOCDIR})

+ 198
- 0
Doxyfile View File

@@ -0,0 +1,198 @@
1
+DOXYFILE_ENCODING      = UTF-8
2
+PROJECT_NAME           = "identiconpp"
3
+PROJECT_NUMBER         = 0.0.0
4
+INPUT                  = README.md src/
5
+USE_MDFILE_AS_MAINPAGE = README.md
6
+CREATE_SUBDIRS         = NO
7
+ALLOW_UNICODE_NAMES    = YES
8
+OUTPUT_LANGUAGE        = English
9
+BRIEF_MEMBER_DESC      = YES
10
+REPEAT_BRIEF           = YES
11
+ALWAYS_DETAILED_SEC    = NO
12
+INLINE_INHERITED_MEMB  = NO
13
+FULL_PATH_NAMES        = YES
14
+SHORT_NAMES            = NO
15
+JAVADOC_AUTOBRIEF      = NO
16
+QT_AUTOBRIEF           = NO
17
+MULTILINE_CPP_IS_BRIEF = NO
18
+INHERIT_DOCS           = YES
19
+SEPARATE_MEMBER_PAGES  = NO
20
+TAB_SIZE               = 4
21
+OPTIMIZE_OUTPUT_FOR_C  = NO
22
+OPTIMIZE_OUTPUT_JAVA   = NO
23
+OPTIMIZE_FOR_FORTRAN   = NO
24
+OPTIMIZE_OUTPUT_VHDL   = NO
25
+MARKDOWN_SUPPORT       = YES
26
+AUTOLINK_SUPPORT       = YES
27
+BUILTIN_STL_SUPPORT    = NO
28
+CPP_CLI_SUPPORT        = NO
29
+SIP_SUPPORT            = NO
30
+IDL_PROPERTY_SUPPORT   = YES
31
+DISTRIBUTE_GROUP_DOC   = NO
32
+GROUP_NESTED_COMPOUNDS = NO
33
+SUBGROUPING            = YES
34
+INLINE_GROUPED_CLASSES = NO
35
+INLINE_SIMPLE_STRUCTS  = NO
36
+TYPEDEF_HIDES_STRUCT   = NO
37
+LOOKUP_CACHE_SIZE      = 0
38
+EXTRACT_ALL            = NO
39
+EXTRACT_PRIVATE        = NO
40
+EXTRACT_PACKAGE        = NO
41
+EXTRACT_STATIC         = NO
42
+EXTRACT_LOCAL_CLASSES  = YES
43
+EXTRACT_LOCAL_METHODS  = NO
44
+EXTRACT_ANON_NSPACES   = NO
45
+HIDE_UNDOC_MEMBERS     = NO
46
+HIDE_UNDOC_CLASSES     = NO
47
+HIDE_FRIEND_COMPOUNDS  = NO
48
+HIDE_IN_BODY_DOCS      = NO
49
+INTERNAL_DOCS          = NO
50
+CASE_SENSE_NAMES       = YES
51
+HIDE_SCOPE_NAMES       = NO
52
+HIDE_COMPOUND_REFERENCE= NO
53
+SHOW_INCLUDE_FILES     = YES
54
+SHOW_GROUPED_MEMB_INC  = NO
55
+FORCE_LOCAL_INCLUDES   = NO
56
+INLINE_INFO            = YES
57
+SORT_MEMBER_DOCS       = YES
58
+SORT_BRIEF_DOCS        = NO
59
+SORT_MEMBERS_CTORS_1ST = NO
60
+SORT_GROUP_NAMES       = NO
61
+SORT_BY_SCOPE_NAME     = NO
62
+STRICT_PROTO_MATCHING  = NO
63
+GENERATE_TODOLIST      = YES
64
+GENERATE_TESTLIST      = YES
65
+GENERATE_BUGLIST       = YES
66
+GENERATE_DEPRECATEDLIST= YES
67
+MAX_INITIALIZER_LINES  = 30
68
+SHOW_USED_FILES        = YES
69
+SHOW_FILES             = YES
70
+SHOW_NAMESPACES        = YES
71
+QUIET                  = NO
72
+WARNINGS               = YES
73
+WARN_IF_UNDOCUMENTED   = YES
74
+WARN_IF_DOC_ERROR      = YES
75
+WARN_NO_PARAMDOC       = NO
76
+WARN_FORMAT            = "$file:$line: $text"
77
+INPUT_ENCODING         = UTF-8
78
+RECURSIVE              = NO
79
+EXCLUDE_SYMLINKS       = NO
80
+EXAMPLE_PATH           = examples
81
+EXAMPLE_RECURSIVE      = YES
82
+FILTER_SOURCE_FILES    = NO
83
+SOURCE_BROWSER         = NO
84
+INLINE_SOURCES         = YES
85
+STRIP_CODE_COMMENTS    = YES
86
+REFERENCED_BY_RELATION = NO
87
+REFERENCES_RELATION    = NO
88
+REFERENCES_LINK_SOURCE = YES
89
+SOURCE_TOOLTIPS        = YES
90
+USE_HTAGS              = NO
91
+VERBATIM_HEADERS       = YES
92
+CLANG_ASSISTED_PARSING = NO
93
+ALPHABETICAL_INDEX     = YES
94
+COLS_IN_ALPHA_INDEX    = 5
95
+GENERATE_HTML          = YES
96
+HTML_OUTPUT            = doc/html
97
+HTML_FILE_EXTENSION    = .html
98
+HTML_COLORSTYLE_HUE    = 220
99
+HTML_COLORSTYLE_SAT    = 100
100
+HTML_COLORSTYLE_GAMMA  = 80
101
+HTML_TIMESTAMP         = NO
102
+HTML_DYNAMIC_SECTIONS  = NO
103
+HTML_INDEX_NUM_ENTRIES = 100
104
+GENERATE_DOCSET        = NO
105
+DOCSET_FEEDNAME        = "Doxygen generated docs"
106
+DOCSET_BUNDLE_ID       = org.doxygen.Project
107
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
108
+DOCSET_PUBLISHER_NAME  = Publisher
109
+GENERATE_HTMLHELP      = NO
110
+GENERATE_CHI           = NO
111
+BINARY_TOC             = NO
112
+TOC_EXPAND             = NO
113
+GENERATE_QHP           = NO
114
+QHP_NAMESPACE          = org.doxygen.Project
115
+QHP_VIRTUAL_FOLDER     = doc
116
+GENERATE_ECLIPSEHELP   = NO
117
+ECLIPSE_DOC_ID         = org.doxygen.Project
118
+DISABLE_INDEX          = NO
119
+GENERATE_TREEVIEW      = NO
120
+ENUM_VALUES_PER_LINE   = 4
121
+TREEVIEW_WIDTH         = 250
122
+EXT_LINKS_IN_WINDOW    = NO
123
+FORMULA_FONTSIZE       = 10
124
+FORMULA_TRANSPARENT    = YES
125
+USE_MATHJAX            = NO
126
+MATHJAX_FORMAT         = HTML-CSS
127
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
128
+SEARCHENGINE           = NO
129
+SERVER_BASED_SEARCH    = NO
130
+EXTERNAL_SEARCH        = NO
131
+SEARCHDATA_FILE        = searchdata.xml
132
+GENERATE_LATEX         = NO
133
+LATEX_OUTPUT           = latex
134
+LATEX_CMD_NAME         = latex
135
+MAKEINDEX_CMD_NAME     = makeindex
136
+COMPACT_LATEX          = NO
137
+PAPER_TYPE             = a4
138
+PDF_HYPERLINKS         = YES
139
+USE_PDFLATEX           = YES
140
+LATEX_BATCHMODE        = NO
141
+LATEX_HIDE_INDICES     = NO
142
+LATEX_SOURCE_CODE      = NO
143
+LATEX_BIB_STYLE        = plain
144
+GENERATE_RTF           = NO
145
+RTF_OUTPUT             = rtf
146
+COMPACT_RTF            = NO
147
+RTF_HYPERLINKS         = NO
148
+RTF_SOURCE_CODE        = NO
149
+GENERATE_MAN           = NO
150
+MAN_OUTPUT             = man
151
+MAN_EXTENSION          = .3
152
+MAN_SUBDIR             =
153
+MAN_LINKS              = NO
154
+GENERATE_XML           = NO
155
+XML_OUTPUT             = xml
156
+XML_PROGRAMLISTING     = YES
157
+GENERATE_DOCBOOK       = NO
158
+DOCBOOK_OUTPUT         = docbook
159
+DOCBOOK_PROGRAMLISTING = NO
160
+GENERATE_AUTOGEN_DEF   = NO
161
+GENERATE_PERLMOD       = NO
162
+PERLMOD_LATEX          = NO
163
+PERLMOD_PRETTY         = YES
164
+ENABLE_PREPROCESSING   = YES
165
+MACRO_EXPANSION        = NO
166
+EXPAND_ONLY_PREDEF     = NO
167
+SEARCH_INCLUDES        = YES
168
+SKIP_FUNCTION_MACROS   = YES
169
+ALLEXTERNALS           = NO
170
+EXTERNAL_GROUPS        = YES
171
+EXTERNAL_PAGES         = YES
172
+PERL_PATH              = /usr/bin/perl
173
+CLASS_DIAGRAMS         = YES
174
+HIDE_UNDOC_RELATIONS   = YES
175
+HAVE_DOT               = NO
176
+DOT_NUM_THREADS        = 0
177
+DOT_FONTNAME           = Helvetica
178
+DOT_FONTSIZE           = 10
179
+CLASS_GRAPH            = YES
180
+COLLABORATION_GRAPH    = YES
181
+GROUP_GRAPHS           = YES
182
+UML_LOOK               = NO
183
+UML_LIMIT_NUM_FIELDS   = 10
184
+TEMPLATE_RELATIONS     = NO
185
+INCLUDE_GRAPH          = YES
186
+INCLUDED_BY_GRAPH      = YES
187
+CALL_GRAPH             = NO
188
+CALLER_GRAPH           = NO
189
+GRAPHICAL_HIERARCHY    = YES
190
+DIRECTORY_GRAPH        = YES
191
+DOT_IMAGE_FORMAT       = png
192
+INTERACTIVE_SVG        = NO
193
+DOT_GRAPH_MAX_NODES    = 50
194
+MAX_DOT_GRAPH_DEPTH    = 0
195
+DOT_TRANSPARENT        = NO
196
+DOT_MULTI_TARGETS      = NO
197
+GENERATE_LEGEND        = YES
198
+DOT_CLEANUP            = YES

+ 674
- 0
LICENSE View File

@@ -0,0 +1,674 @@
1
+                    GNU GENERAL PUBLIC LICENSE
2
+                       Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+                            Preamble
9
+
10
+  The GNU General Public License is a free, copyleft license for
11
+software and other kinds of works.
12
+
13
+  The licenses for most software and other practical works are designed
14
+to take away your freedom to share and change the works.  By contrast,
15
+the GNU General Public License is intended to guarantee your freedom to
16
+share and change all versions of a program--to make sure it remains free
17
+software for all its users.  We, the Free Software Foundation, use the
18
+GNU General Public License for most of our software; it applies also to
19
+any other work released this way by its authors.  You can apply it to
20
+your programs, too.
21
+
22
+  When we speak of free software, we are referring to freedom, not
23
+price.  Our General Public Licenses are designed to make sure that you
24
+have the freedom to distribute copies of free software (and charge for
25
+them if you wish), that you receive source code or can get it if you
26
+want it, that you can change the software or use pieces of it in new
27
+free programs, and that you know you can do these things.
28
+
29
+  To protect your rights, we need to prevent others from denying you
30
+these rights or asking you to surrender the rights.  Therefore, you have
31
+certain responsibilities if you distribute copies of the software, or if
32
+you modify it: responsibilities to respect the freedom of others.
33
+
34
+  For example, if you distribute copies of such a program, whether
35
+gratis or for a fee, you must pass on to the recipients the same
36
+freedoms that you received.  You must make sure that they, too, receive
37
+or can get the source code.  And you must show them these terms so they
38
+know their rights.
39
+
40
+  Developers that use the GNU GPL protect your rights with two steps:
41
+(1) assert copyright on the software, and (2) offer you this License
42
+giving you legal permission to copy, distribute and/or modify it.
43
+
44
+  For the developers' and authors' protection, the GPL clearly explains
45
+that there is no warranty for this free software.  For both users' and
46
+authors' sake, the GPL requires that modified versions be marked as
47
+changed, so that their problems will not be attributed erroneously to
48
+authors of previous versions.
49
+
50
+  Some devices are designed to deny users access to install or run
51
+modified versions of the software inside them, although the manufacturer
52
+can do so.  This is fundamentally incompatible with the aim of
53
+protecting users' freedom to change the software.  The systematic
54
+pattern of such abuse occurs in the area of products for individuals to
55
+use, which is precisely where it is most unacceptable.  Therefore, we
56
+have designed this version of the GPL to prohibit the practice for those
57
+products.  If such problems arise substantially in other domains, we
58
+stand ready to extend this provision to those domains in future versions
59
+of the GPL, as needed to protect the freedom of users.
60
+
61
+  Finally, every program is threatened constantly by software patents.
62
+States should not allow patents to restrict development and use of
63
+software on general-purpose computers, but in those that do, we wish to
64
+avoid the special danger that patents applied to a free program could
65
+make it effectively proprietary.  To prevent this, the GPL assures that
66
+patents cannot be used to render the program non-free.
67
+
68
+  The precise terms and conditions for copying, distribution and
69
+modification follow.
70
+
71
+                       TERMS AND CONDITIONS
72
+
73
+  0. Definitions.
74
+
75
+  "This License" refers to version 3 of the GNU General Public License.
76
+
77
+  "Copyright" also means copyright-like laws that apply to other kinds of
78
+works, such as semiconductor masks.
79
+
80
+  "The Program" refers to any copyrightable work licensed under this
81
+License.  Each licensee is addressed as "you".  "Licensees" and
82
+"recipients" may be individuals or organizations.
83
+
84
+  To "modify" a work means to copy from or adapt all or part of the work
85
+in a fashion requiring copyright permission, other than the making of an
86
+exact copy.  The resulting work is called a "modified version" of the
87
+earlier work or a work "based on" the earlier work.
88
+
89
+  A "covered work" means either the unmodified Program or a work based
90
+on the Program.
91
+
92
+  To "propagate" a work means to do anything with it that, without
93
+permission, would make you directly or secondarily liable for
94
+infringement under applicable copyright law, except executing it on a
95
+computer or modifying a private copy.  Propagation includes copying,
96
+distribution (with or without modification), making available to the
97
+public, and in some countries other activities as well.
98
+
99
+  To "convey" a work means any kind of propagation that enables other
100
+parties to make or receive copies.  Mere interaction with a user through
101
+a computer network, with no transfer of a copy, is not conveying.
102
+
103
+  An interactive user interface displays "Appropriate Legal Notices"
104
+to the extent that it includes a convenient and prominently visible
105
+feature that (1) displays an appropriate copyright notice, and (2)
106
+tells the user that there is no warranty for the work (except to the
107
+extent that warranties are provided), that licensees may convey the
108
+work under this License, and how to view a copy of this License.  If
109
+the interface presents a list of user commands or options, such as a
110
+menu, a prominent item in the list meets this criterion.
111
+
112
+  1. Source Code.
113
+
114
+  The "source code" for a work means the preferred form of the work
115
+for making modifications to it.  "Object code" means any non-source
116
+form of a work.
117
+
118
+  A "Standard Interface" means an interface that either is an official
119
+standard defined by a recognized standards body, or, in the case of
120
+interfaces specified for a particular programming language, one that
121
+is widely used among developers working in that language.
122
+
123
+  The "System Libraries" of an executable work include anything, other
124
+than the work as a whole, that (a) is included in the normal form of
125
+packaging a Major Component, but which is not part of that Major
126
+Component, and (b) serves only to enable use of the work with that
127
+Major Component, or to implement a Standard Interface for which an
128
+implementation is available to the public in source code form.  A
129
+"Major Component", in this context, means a major essential component
130
+(kernel, window system, and so on) of the specific operating system
131
+(if any) on which the executable work runs, or a compiler used to
132
+produce the work, or an object code interpreter used to run it.
133
+
134
+  The "Corresponding Source" for a work in object code form means all
135
+the source code needed to generate, install, and (for an executable
136
+work) run the object code and to modify the work, including scripts to
137
+control those activities.  However, it does not include the work's
138
+System Libraries, or general-purpose tools or generally available free
139
+programs which are used unmodified in performing those activities but
140
+which are not part of the work.  For example, Corresponding Source
141
+includes interface definition files associated with source files for
142
+the work, and the source code for shared libraries and dynamically
143
+linked subprograms that the work is specifically designed to require,
144
+such as by intimate data communication or control flow between those
145
+subprograms and other parts of the work.
146
+
147
+  The Corresponding Source need not include anything that users
148
+can regenerate automatically from other parts of the Corresponding
149
+Source.
150
+
151
+  The Corresponding Source for a work in source code form is that
152
+same work.
153
+
154
+  2. Basic Permissions.
155
+
156
+  All rights granted under this License are granted for the term of
157
+copyright on the Program, and are irrevocable provided the stated
158
+conditions are met.  This License explicitly affirms your unlimited
159
+permission to run the unmodified Program.  The output from running a
160
+covered work is covered by this License only if the output, given its
161
+content, constitutes a covered work.  This License acknowledges your
162
+rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+  You may make, run and propagate covered works that you do not
165
+convey, without conditions so long as your license otherwise remains
166
+in force.  You may convey covered works to others for the sole purpose
167
+of having them make modifications exclusively for you, or provide you
168
+with facilities for running those works, provided that you comply with
169
+the terms of this License in conveying all material for which you do
170
+not control copyright.  Those thus making or running the covered works
171
+for you must do so exclusively on your behalf, under your direction
172
+and control, on terms that prohibit them from making any copies of
173
+your copyrighted material outside their relationship with you.
174
+
175
+  Conveying under any other circumstances is permitted solely under
176
+the conditions stated below.  Sublicensing is not allowed; section 10
177
+makes it unnecessary.
178
+
179
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+  No covered work shall be deemed part of an effective technological
182
+measure under any applicable law fulfilling obligations under article
183
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+similar laws prohibiting or restricting circumvention of such
185
+measures.
186
+
187
+  When you convey a covered work, you waive any legal power to forbid
188
+circumvention of technological measures to the extent such circumvention
189
+is effected by exercising rights under this License with respect to
190
+the covered work, and you disclaim any intention to limit operation or
191
+modification of the work as a means of enforcing, against the work's
192
+users, your or third parties' legal rights to forbid circumvention of
193
+technological measures.
194
+
195
+  4. Conveying Verbatim Copies.
196
+
197
+  You may convey verbatim copies of the Program's source code as you
198
+receive it, in any medium, provided that you conspicuously and
199
+appropriately publish on each copy an appropriate copyright notice;
200
+keep intact all notices stating that this License and any
201
+non-permissive terms added in accord with section 7 apply to the code;
202
+keep intact all notices of the absence of any warranty; and give all
203
+recipients a copy of this License along with the Program.
204
+
205
+  You may charge any price or no price for each copy that you convey,
206
+and you may offer support or warranty protection for a fee.
207
+
208
+  5. Conveying Modified Source Versions.
209
+
210
+  You may convey a work based on the Program, or the modifications to
211
+produce it from the Program, in the form of source code under the
212
+terms of section 4, provided that you also meet all of these conditions:
213
+
214
+    a) The work must carry prominent notices stating that you modified
215
+    it, and giving a relevant date.
216
+
217
+    b) The work must carry prominent notices stating that it is
218
+    released under this License and any conditions added under section
219
+    7.  This requirement modifies the requirement in section 4 to
220
+    "keep intact all notices".
221
+
222
+    c) You must license the entire work, as a whole, under this
223
+    License to anyone who comes into possession of a copy.  This
224
+    License will therefore apply, along with any applicable section 7
225
+    additional terms, to the whole of the work, and all its parts,
226
+    regardless of how they are packaged.  This License gives no
227
+    permission to license the work in any other way, but it does not
228
+    invalidate such permission if you have separately received it.
229
+
230
+    d) If the work has interactive user interfaces, each must display
231
+    Appropriate Legal Notices; however, if the Program has interactive
232
+    interfaces that do not display Appropriate Legal Notices, your
233
+    work need not make them do so.
234
+
235
+  A compilation of a covered work with other separate and independent
236
+works, which are not by their nature extensions of the covered work,
237
+and which are not combined with it such as to form a larger program,
238
+in or on a volume of a storage or distribution medium, is called an
239
+"aggregate" if the compilation and its resulting copyright are not
240
+used to limit the access or legal rights of the compilation's users
241
+beyond what the individual works permit.  Inclusion of a covered work
242
+in an aggregate does not cause this License to apply to the other
243
+parts of the aggregate.
244
+
245
+  6. Conveying Non-Source Forms.
246
+
247
+  You may convey a covered work in object code form under the terms
248
+of sections 4 and 5, provided that you also convey the
249
+machine-readable Corresponding Source under the terms of this License,
250
+in one of these ways:
251
+
252
+    a) Convey the object code in, or embodied in, a physical product
253
+    (including a physical distribution medium), accompanied by the
254
+    Corresponding Source fixed on a durable physical medium
255
+    customarily used for software interchange.
256
+
257
+    b) Convey the object code in, or embodied in, a physical product
258
+    (including a physical distribution medium), accompanied by a
259
+    written offer, valid for at least three years and valid for as
260
+    long as you offer spare parts or customer support for that product
261
+    model, to give anyone who possesses the object code either (1) a
262
+    copy of the Corresponding Source for all the software in the
263
+    product that is covered by this License, on a durable physical
264
+    medium customarily used for software interchange, for a price no
265
+    more than your reasonable cost of physically performing this
266
+    conveying of source, or (2) access to copy the
267
+    Corresponding Source from a network server at no charge.
268
+
269
+    c) Convey individual copies of the object code with a copy of the
270
+    written offer to provide the Corresponding Source.  This
271
+    alternative is allowed only occasionally and noncommercially, and
272
+    only if you received the object code with such an offer, in accord
273
+    with subsection 6b.
274
+
275
+    d) Convey the object code by offering access from a designated
276
+    place (gratis or for a charge), and offer equivalent access to the
277
+    Corresponding Source in the same way through the same place at no
278
+    further charge.  You need not require recipients to copy the
279
+    Corresponding Source along with the object code.  If the place to
280
+    copy the object code is a network server, the Corresponding Source
281
+    may be on a different server (operated by you or a third party)
282
+    that supports equivalent copying facilities, provided you maintain
283
+    clear directions next to the object code saying where to find the
284
+    Corresponding Source.  Regardless of what server hosts the
285
+    Corresponding Source, you remain obligated to ensure that it is
286
+    available for as long as needed to satisfy these requirements.
287
+
288
+    e) Convey the object code using peer-to-peer transmission, provided
289
+    you inform other peers where the object code and Corresponding
290
+    Source of the work are being offered to the general public at no
291
+    charge under subsection 6d.
292
+
293
+  A separable portion of the object code, whose source code is excluded
294
+from the Corresponding Source as a System Library, need not be
295
+included in conveying the object code work.
296
+
297
+  A "User Product" is either (1) a "consumer product", which means any
298
+tangible personal property which is normally used for personal, family,
299
+or household purposes, or (2) anything designed or sold for incorporation
300
+into a dwelling.  In determining whether a product is a consumer product,
301
+doubtful cases shall be resolved in favor of coverage.  For a particular
302
+product received by a particular user, "normally used" refers to a
303
+typical or common use of that class of product, regardless of the status
304
+of the particular user or of the way in which the particular user
305
+actually uses, or expects or is expected to use, the product.  A product
306
+is a consumer product regardless of whether the product has substantial
307
+commercial, industrial or non-consumer uses, unless such uses represent
308
+the only significant mode of use of the product.
309
+
310
+  "Installation Information" for a User Product means any methods,
311
+procedures, authorization keys, or other information required to install
312
+and execute modified versions of a covered work in that User Product from
313
+a modified version of its Corresponding Source.  The information must
314
+suffice to ensure that the continued functioning of the modified object
315
+code is in no case prevented or interfered with solely because
316
+modification has been made.
317
+
318
+  If you convey an object code work under this section in, or with, or
319
+specifically for use in, a User Product, and the conveying occurs as
320
+part of a transaction in which the right of possession and use of the
321
+User Product is transferred to the recipient in perpetuity or for a
322
+fixed term (regardless of how the transaction is characterized), the
323
+Corresponding Source conveyed under this section must be accompanied
324
+by the Installation Information.  But this requirement does not apply
325
+if neither you nor any third party retains the ability to install
326
+modified object code on the User Product (for example, the work has
327
+been installed in ROM).
328
+
329
+  The requirement to provide Installation Information does not include a
330
+requirement to continue to provide support service, warranty, or updates
331
+for a work that has been modified or installed by the recipient, or for
332
+the User Product in which it has been modified or installed.  Access to a
333
+network may be denied when the modification itself materially and
334
+adversely affects the operation of the network or violates the rules and
335
+protocols for communication across the network.
336
+
337
+  Corresponding Source conveyed, and Installation Information provided,
338
+in accord with this section must be in a format that is publicly
339
+documented (and with an implementation available to the public in
340
+source code form), and must require no special password or key for
341
+unpacking, reading or copying.
342
+
343
+  7. Additional Terms.
344
+
345
+  "Additional permissions" are terms that supplement the terms of this
346
+License by making exceptions from one or more of its conditions.
347
+Additional permissions that are applicable to the entire Program shall
348
+be treated as though they were included in this License, to the extent
349
+that they are valid under applicable law.  If additional permissions
350
+apply only to part of the Program, that part may be used separately
351
+under those permissions, but the entire Program remains governed by
352
+this License without regard to the additional permissions.
353
+
354
+  When you convey a copy of a covered work, you may at your option
355
+remove any additional permissions from that copy, or from any part of
356
+it.  (Additional permissions may be written to require their own
357
+removal in certain cases when you modify the work.)  You may place
358
+additional permissions on material, added by you to a covered work,
359
+for which you have or can give appropriate copyright permission.
360
+
361
+  Notwithstanding any other provision of this License, for material you
362
+add to a covered work, you may (if authorized by the copyright holders of
363
+that material) supplement the terms of this License with terms:
364
+
365
+    a) Disclaiming warranty or limiting liability differently from the
366
+    terms of sections 15 and 16 of this License; or
367
+
368
+    b) Requiring preservation of specified reasonable legal notices or
369
+    author attributions in that material or in the Appropriate Legal
370
+    Notices displayed by works containing it; or
371
+
372
+    c) Prohibiting misrepresentation of the origin of that material, or
373
+    requiring that modified versions of such material be marked in
374
+    reasonable ways as different from the original version; or
375
+
376
+    d) Limiting the use for publicity purposes of names of licensors or
377
+    authors of the material; or
378
+
379
+    e) Declining to grant rights under trademark law for use of some
380
+    trade names, trademarks, or service marks; or
381
+
382
+    f) Requiring indemnification of licensors and authors of that
383
+    material by anyone who conveys the material (or modified versions of
384
+    it) with contractual assumptions of liability to the recipient, for
385
+    any liability that these contractual assumptions directly impose on
386
+    those licensors and authors.
387
+
388
+  All other non-permissive additional terms are considered "further
389
+restrictions" within the meaning of section 10.  If the Program as you
390
+received it, or any part of it, contains a notice stating that it is
391
+governed by this License along with a term that is a further
392
+restriction, you may remove that term.  If a license document contains
393
+a further restriction but permits relicensing or conveying under this
394
+License, you may add to a covered work material governed by the terms
395
+of that license document, provided that the further restriction does
396
+not survive such relicensing or conveying.
397
+
398
+  If you add terms to a covered work in accord with this section, you
399
+must place, in the relevant source files, a statement of the
400
+additional terms that apply to those files, or a notice indicating
401
+where to find the applicable terms.
402
+
403
+  Additional terms, permissive or non-permissive, may be stated in the
404
+form of a separately written license, or stated as exceptions;
405
+the above requirements apply either way.
406
+
407
+  8. Termination.
408
+
409
+  You may not propagate or modify a covered work except as expressly
410
+provided under this License.  Any attempt otherwise to propagate or
411
+modify it is void, and will automatically terminate your rights under
412
+this License (including any patent licenses granted under the third
413
+paragraph of section 11).
414
+
415
+  However, if you cease all violation of this License, then your
416
+license from a particular copyright holder is reinstated (a)
417
+provisionally, unless and until the copyright holder explicitly and
418
+finally terminates your license, and (b) permanently, if the copyright
419
+holder fails to notify you of the violation by some reasonable means
420
+prior to 60 days after the cessation.
421
+
422
+  Moreover, your license from a particular copyright holder is
423
+reinstated permanently if the copyright holder notifies you of the
424
+violation by some reasonable means, this is the first time you have
425
+received notice of violation of this License (for any work) from that
426
+copyright holder, and you cure the violation prior to 30 days after
427
+your receipt of the notice.
428
+
429
+  Termination of your rights under this section does not terminate the
430
+licenses of parties who have received copies or rights from you under
431
+this License.  If your rights have been terminated and not permanently
432
+reinstated, you do not qualify to receive new licenses for the same
433
+material under section 10.
434
+
435
+  9. Acceptance Not Required for Having Copies.
436
+
437
+  You are not required to accept this License in order to receive or
438
+run a copy of the Program.  Ancillary propagation of a covered work
439
+occurring solely as a consequence of using peer-to-peer transmission
440
+to receive a copy likewise does not require acceptance.  However,
441
+nothing other than this License grants you permission to propagate or
442
+modify any covered work.  These actions infringe copyright if you do
443
+not accept this License.  Therefore, by modifying or propagating a
444
+covered work, you indicate your acceptance of this License to do so.
445
+
446
+  10. Automatic Licensing of Downstream Recipients.
447
+
448
+  Each time you convey a covered work, the recipient automatically
449
+receives a license from the original licensors, to run, modify and
450
+propagate that work, subject to this License.  You are not responsible
451
+for enforcing compliance by third parties with this License.
452
+
453
+  An "entity transaction" is a transaction transferring control of an
454
+organization, or substantially all assets of one, or subdividing an
455
+organization, or merging organizations.  If propagation of a covered
456
+work results from an entity transaction, each party to that
457
+transaction who receives a copy of the work also receives whatever
458
+licenses to the work the party's predecessor in interest had or could
459
+give under the previous paragraph, plus a right to possession of the
460
+Corresponding Source of the work from the predecessor in interest, if
461
+the predecessor has it or can get it with reasonable efforts.
462
+
463
+  You may not impose any further restrictions on the exercise of the
464
+rights granted or affirmed under this License.  For example, you may
465
+not impose a license fee, royalty, or other charge for exercise of
466
+rights granted under this License, and you may not initiate litigation
467
+(including a cross-claim or counterclaim in a lawsuit) alleging that
468
+any patent claim is infringed by making, using, selling, offering for
469
+sale, or importing the Program or any portion of it.
470
+
471
+  11. Patents.
472
+
473
+  A "contributor" is a copyright holder who authorizes use under this
474
+License of the Program or a work on which the Program is based.  The
475
+work thus licensed is called the contributor's "contributor version".
476
+
477
+  A contributor's "essential patent claims" are all patent claims
478
+owned or controlled by the contributor, whether already acquired or
479
+hereafter acquired, that would be infringed by some manner, permitted
480
+by this License, of making, using, or selling its contributor version,
481
+but do not include claims that would be infringed only as a
482
+consequence of further modification of the contributor version.  For
483
+purposes of this definition, "control" includes the right to grant
484
+patent sublicenses in a manner consistent with the requirements of
485
+this License.
486
+
487
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+patent license under the contributor's essential patent claims, to
489
+make, use, sell, offer for sale, import and otherwise run, modify and
490
+propagate the contents of its contributor version.
491
+
492
+  In the following three paragraphs, a "patent license" is any express
493
+agreement or commitment, however denominated, not to enforce a patent
494
+(such as an express permission to practice a patent or covenant not to
495
+sue for patent infringement).  To "grant" such a patent license to a
496
+party means to make such an agreement or commitment not to enforce a
497
+patent against the party.
498
+
499
+  If you convey a covered work, knowingly relying on a patent license,
500
+and the Corresponding Source of the work is not available for anyone
501
+to copy, free of charge and under the terms of this License, through a
502
+publicly available network server or other readily accessible means,
503
+then you must either (1) cause the Corresponding Source to be so
504
+available, or (2) arrange to deprive yourself of the benefit of the
505
+patent license for this particular work, or (3) arrange, in a manner
506
+consistent with the requirements of this License, to extend the patent
507
+license to downstream recipients.  "Knowingly relying" means you have
508
+actual knowledge that, but for the patent license, your conveying the
509
+covered work in a country, or your recipient's use of the covered work
510
+in a country, would infringe one or more identifiable patents in that
511
+country that you have reason to believe are valid.
512
+
513
+  If, pursuant to or in connection with a single transaction or
514
+arrangement, you convey, or propagate by procuring conveyance of, a
515
+covered work, and grant a patent license to some of the parties
516
+receiving the covered work authorizing them to use, propagate, modify
517
+or convey a specific copy of the covered work, then the patent license
518
+you grant is automatically extended to all recipients of the covered
519
+work and works based on it.
520
+
521
+  A patent license is "discriminatory" if it does not include within
522
+the scope of its coverage, prohibits the exercise of, or is
523
+conditioned on the non-exercise of one or more of the rights that are
524
+specifically granted under this License.  You may not convey a covered
525
+work if you are a party to an arrangement with a third party that is
526
+in the business of distributing software, under which you make payment
527
+to the third party based on the extent of your activity of conveying
528
+the work, and under which the third party grants, to any of the
529
+parties who would receive the covered work from you, a discriminatory
530
+patent license (a) in connection with copies of the covered work
531
+conveyed by you (or copies made from those copies), or (b) primarily
532
+for and in connection with specific products or compilations that
533
+contain the covered work, unless you entered into that arrangement,
534
+or that patent license was granted, prior to 28 March 2007.
535
+
536
+  Nothing in this License shall be construed as excluding or limiting
537
+any implied license or other defenses to infringement that may
538
+otherwise be available to you under applicable patent law.
539
+
540
+  12. No Surrender of Others' Freedom.
541
+
542
+  If conditions are imposed on you (whether by court order, agreement or
543
+otherwise) that contradict the conditions of this License, they do not
544
+excuse you from the conditions of this License.  If you cannot convey a
545
+covered work so as to satisfy simultaneously your obligations under this
546
+License and any other pertinent obligations, then as a consequence you may
547
+not convey it at all.  For example, if you agree to terms that obligate you
548
+to collect a royalty for further conveying from those to whom you convey
549
+the Program, the only way you could satisfy both those terms and this
550
+License would be to refrain entirely from conveying the Program.
551
+
552
+  13. Use with the GNU Affero General Public License.
553
+
554
+  Notwithstanding any other provision of this License, you have
555
+permission to link or combine any covered work with a work licensed
556
+under version 3 of the GNU Affero General Public License into a single
557
+combined work, and to convey the resulting work.  The terms of this
558
+License will continue to apply to the part which is the covered work,
559
+but the special requirements of the GNU Affero General Public License,
560
+section 13, concerning interaction through a network will apply to the
561
+combination as such.
562
+
563
+  14. Revised Versions of this License.
564
+
565
+  The Free Software Foundation may publish revised and/or new versions of
566
+the GNU General Public License from time to time.  Such new versions will
567
+be similar in spirit to the present version, but may differ in detail to
568
+address new problems or concerns.
569
+
570
+  Each version is given a distinguishing version number.  If the
571
+Program specifies that a certain numbered version of the GNU General
572
+Public License "or any later version" applies to it, you have the
573
+option of following the terms and conditions either of that numbered
574
+version or of any later version published by the Free Software
575
+Foundation.  If the Program does not specify a version number of the
576
+GNU General Public License, you may choose any version ever published
577
+by the Free Software Foundation.
578
+
579
+  If the Program specifies that a proxy can decide which future
580
+versions of the GNU General Public License can be used, that proxy's
581
+public statement of acceptance of a version permanently authorizes you
582
+to choose that version for the Program.
583
+
584
+  Later license versions may give you additional or different
585
+permissions.  However, no additional obligations are imposed on any
586
+author or copyright holder as a result of your choosing to follow a
587
+later version.
588
+
589
+  15. Disclaimer of Warranty.
590
+
591
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+  16. Limitation of Liability.
601
+
602
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+SUCH DAMAGES.
611
+
612
+  17. Interpretation of Sections 15 and 16.
613
+
614
+  If the disclaimer of warranty and limitation of liability provided
615
+above cannot be given local legal effect according to their terms,
616
+reviewing courts shall apply local law that most closely approximates
617
+an absolute waiver of all civil liability in connection with the
618
+Program, unless a warranty or assumption of liability accompanies a
619
+copy of the Program in return for a fee.
620
+
621
+                     END OF TERMS AND CONDITIONS
622
+
623
+            How to Apply These Terms to Your New Programs
624
+
625
+  If you develop a new program, and you want it to be of the greatest
626
+possible use to the public, the best way to achieve this is to make it
627
+free software which everyone can redistribute and change under these terms.
628
+
629
+  To do so, attach the following notices to the program.  It is safest
630
+to attach them to the start of each source file to most effectively
631
+state the exclusion of warranty; and each file should have at least
632
+the "copyright" line and a pointer to where the full notice is found.
633
+
634
+    <one line to give the program's name and a brief idea of what it does.>
635
+    Copyright (C) <year>  <name of author>
636
+
637
+    This program is free software: you can redistribute it and/or modify
638
+    it under the terms of the GNU General Public License as published by
639
+    the Free Software Foundation, either version 3 of the License, or
640
+    (at your option) any later version.
641
+
642
+    This program is distributed in the hope that it will be useful,
643
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
644
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645
+    GNU General Public License for more details.
646
+
647
+    You should have received a copy of the GNU General Public License
648
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
649
+
650
+Also add information on how to contact you by electronic and paper mail.
651
+
652
+  If the program does terminal interaction, make it output a short
653
+notice like this when it starts in an interactive mode:
654
+
655
+    <program>  Copyright (C) <year>  <name of author>
656
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
+    This is free software, and you are welcome to redistribute it
658
+    under certain conditions; type `show c' for details.
659
+
660
+The hypothetical commands `show w' and `show c' should show the appropriate
661
+parts of the General Public License.  Of course, your program's commands
662
+might be different; for a GUI interface, you would use an "about box".
663
+
664
+  You should also get your employer (if you work as a programmer) or school,
665
+if any, to sign a "copyright disclaimer" for the program, if necessary.
666
+For more information on this, and how to apply and follow the GNU GPL, see
667
+<http://www.gnu.org/licenses/>.
668
+
669
+  The GNU General Public License does not permit incorporating your program
670
+into proprietary programs.  If your program is a subroutine library, you
671
+may consider it more useful to permit linking proprietary applications with
672
+the library.  If this is what you want to do, use the GNU Lesser General
673
+Public License instead of this License.  But first, please read
674
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

+ 57
- 0
README.md View File

@@ -0,0 +1,57 @@
1
+**identiconpp** is a library to generate identicons. Written in C++.
2
+
3
+## Features
4
+
5
+## Example
6
+
7
+## Install
8
+
9
+<!-- ### Gentoo
10
+
11
+Gentoo ebuilds are available via my
12
+[repository](https://schlomp.space/tastytea/overlay). -->
13
+
14
+### From source
15
+
16
+#### Dependencies
17
+
18
+* C++ compiler (tested: [gcc](https://gcc.gnu.org/) 5/6/7/8,
19
+  [clang](https://llvm.org/) 5/6)
20
+* [cmake](https://cmake.org/) (at least 3.2)
21
+* [crypto++](https://cryptopp.com) (tested: 7.0 / 5.6)
22
+* [imagemagick](https://www.imagemagick.org/) (tested: 7.0 / 6.7)
23
+
24
+On a Debian system, install the packages: `build-essential cmake libcrypto++-dev
25
+libmagick++-dev`.
26
+
27
+#### Compile
28
+
29
+```SH
30
+mkdir build
31
+cd build
32
+cmake ..
33
+make
34
+make install
35
+```
36
+
37
+##### cmake options
38
+
39
+* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
40
+
41
+## Contributing
42
+
43
+Contributions are always welcome. You can submit them as pull requests or via
44
+email to `tastytea`@`tastytea.de`.
45
+
46
+## Contact
47
+
48
+See https://tastytea.de/
49
+
50
+## License & Copyright
51
+
52
+```PLAIN
53
+Copyright © 2018 tastytea <tastytea@tastytea.de>.
54
+License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
55
+This program comes with ABSOLUTELY NO WARRANTY. This is free software,
56
+and you are welcome to redistribute it under certain conditions.
57
+```

+ 8
- 0
build_doc.sh View File

@@ -0,0 +1,8 @@
1
+#!/bin/sh
2
+
3
+if [ -f Doxyfile ]; then
4
+    mkdir -p doc
5
+    (cat Doxyfile && echo -n "PROJECT_NUMBER = " &&
6
+       grep -Eo '[0-9]+.[0-9]+.[0-9]+$' CMakeLists.txt) \
7
+       | doxygen -
8
+fi

+ 33
- 0
example.cpp View File

@@ -0,0 +1,33 @@
1
+/*  This file is part of identiconpp.
2
+ *  Public Domain / CC-0
3
+ */
4
+
5
+#include <iostream>
6
+#include <string>
7
+#include "identiconpp.hpp"
8
+
9
+using std::cout;
10
+using std::string;
11
+
12
+int main(int argc, char *argv[])
13
+{
14
+    string algorithm = "simple";
15
+    if (argc > 1)
16
+    {
17
+        algorithm = argv[1];
18
+    }
19
+
20
+    if (algorithm == "simple")
21
+    {
22
+        cout << "You selected the \"simple\" algorithm.\n";
23
+    }
24
+    else
25
+    {
26
+        cout << "The algorithm \"" << algorithm << "\" is not known.\n";
27
+        return 1;
28
+    }
29
+
30
+    Identiconpp identicon(5, 5, "ffffffff", {"000000ff", "000000"});
31
+
32
+    return 0;
33
+}

+ 31
- 0
src/debug.hpp View File

@@ -0,0 +1,31 @@
1
+/*  This file is part of identiconpp.
2
+ *  Copyright © 2018 tastytea <tastytea@tastytea.de>
3
+ *                                                                   
4
+ *  This program is free software: you can redistribute it and/or modify
5
+ *  it under the terms of the GNU General Public License as published by
6
+ *  the Free Software Foundation, version 3.
7
+ *
8
+ *  This program is distributed in the hope that it will be useful,
9
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
10
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
+ *  GNU General Public License for more details.
12
+ *
13
+ *  You should have received a copy of the GNU General Public License
14
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
15
+ */
16
+
17
+#ifndef DEBUG_HPP
18
+#define DEBUG_HPP
19
+
20
+#include <iostream>
21
+#include <exception>
22
+#include <stdexcept>
23
+#include <sstream>
24
+
25
+#ifdef DEBUG
26
+    #define ttdebug std::cerr << "[" << __FILE__ << ":" << __LINE__ << "] DEBUG: "
27
+#else
28
+    #define ttdebug false && std::cerr
29
+#endif
30
+
31
+#endif // DEBUG_HPP

+ 45
- 0
src/identiconpp.cpp View File

@@ -0,0 +1,45 @@
1
+/*  This file is part of identiconpp.
2
+ *  Copyright © 2018 tastytea <tastytea@tastytea.de>
3
+ *
4
+ *  This program is free software: you can redistribute it and/or modify
5
+ *  it under the terms of the GNU General Public License as published by
6
+ *  the Free Software Foundation, version 3.
7
+ *
8
+ *  This program is distributed in the hope that it will be useful,
9
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
10
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
+ *  GNU General Public License for more details.
12
+ *
13
+ *  You should have received a copy of the GNU General Public License
14
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
15
+ */
16
+
17
+#include <exception>
18
+#include <stdexcept>
19
+#include "identiconpp.hpp"
20
+#include "debug.hpp"
21
+
22
+Identiconpp::Identiconpp(const uint8_t rows, const uint8_t columns,
23
+                         const string &background,
24
+                         const vector<string> &foreground)
25
+: _rows(rows)
26
+, _columns(columns)
27
+, _background(background)
28
+, _foreground(foreground)
29
+{
30
+    // TODO: Check rows and columns
31
+    if (_background.size() != 8)
32
+    {
33
+        throw std::invalid_argument("Background color has the wrong format: " +
34
+                                    _background);
35
+    }
36
+    for (const string &color : _foreground)
37
+    {
38
+        if (color.size() != 8)
39
+        {
40
+            throw std::invalid_argument("Foreground color has the wrong format: " +
41
+                                        color);
42
+        }
43
+    }
44
+}
45
+

+ 54
- 0
src/identiconpp.hpp View File

@@ -0,0 +1,54 @@
1
+/*  This file is part of identiconpp.
2
+ *  Copyright © 2018 tastytea <tastytea@tastytea.de>
3
+ *
4
+ *  This program is free software: you can redistribute it and/or modify
5
+ *  it under the terms of the GNU General Public License as published by
6
+ *  the Free Software Foundation, version 3.
7
+ *
8
+ *  This program is distributed in the hope that it will be useful,
9
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
10
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
+ *  GNU General Public License for more details.
12
+ *
13
+ *  You should have received a copy of the GNU General Public License
14
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
15
+ */
16
+
17
+#include <cstdint>
18
+#include <string>
19
+#include <vector>
20
+
21
+using std::uint8_t;
22
+using std::string;
23
+using std::vector;
24
+
25
+/*!
26
+ *  @brief  Base class for identiconpp.
27
+ *
28
+ *          Use this class for all your identicons.
29
+ */
30
+class Identiconpp
31
+{
32
+public:
33
+    /*!
34
+     *  @brief  Initialises an instance of Identiconpp.
35
+     *
36
+     *          The instance can be used for creating identicons with differing
37
+     *          image formats and sizes. Will throw `std::invalid_argument` if
38
+     *          an argument is invalid.
39
+     *
40
+     *  @param  rows        Number of rows
41
+     *  @param  columns     Number of columns
42
+     *  @param  background  Background color, hexadecimal, rrggbbaa
43
+     *  @param  foreground  vector of foreground colors
44
+     */
45
+    explicit Identiconpp(const uint8_t rows, const uint8_t columns,
46
+                         const string &background = "ffffffff",
47
+                         const vector<string> &foreground = { "000000ff" } );
48
+
49
+private:
50
+    const uint8_t _rows;
51
+    const uint8_t _columns;
52
+    const string _background;
53
+    const vector<string> _foreground;
54
+};

Loading…
Cancel
Save