├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── c-doku.c
├── helpers.c
├── helpers.h
├── interface.c
├── interface.h
├── sudoku.c
├── sudoku.h
└── tests.c
/.gitignore:
--------------------------------------------------------------------------------
1 | c-doku
2 | c-doku.o
3 | helpers.o
4 | interface.o
5 | LICENSE
6 | Makefile
7 | README.md
8 | sudoku.o
9 | tests
10 | tests.o
11 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
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 |
635 | Copyright (C)
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 .
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 | Copyright (C)
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 | .
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 | .
675 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | .POSIX:
2 | CC = gcc
3 | CFLAGS = -std=c99 -Wall -pedantic -Werror -Wextra -O3
4 | LDLIBS = -lncurses
5 |
6 | obj = c-doku.o helpers.o interface.o sudoku.o
7 | testobj = helpers.o sudoku.o tests.o
8 |
9 | all: c-doku
10 |
11 | play: c-doku
12 | ./c-doku
13 |
14 | check: tests
15 | ./tests
16 |
17 | c-doku: $(obj)
18 | $(CC) $(LDFLAGS) $(CFLAGS) -o $@ $(obj) $(LDLIBS)
19 |
20 | tests: $(testobj)
21 | $(CC) $(LDFLAGS) $(CFLAGS) -o $@ $(testobj) -lcmocka
22 |
23 | c-doku.o: c-doku.c sudoku.h interface.h
24 | helpers.o: helpers.c sudoku.h
25 | interface.o: interface.c sudoku.h
26 | sudoku.o: sudoku.c helpers.h sudoku.h
27 | tests.o: tests.c helpers.h sudoku.h
28 |
29 | clean:
30 | rm -f c-doku tests c-doku.x $(obj) $(testobj)
31 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # C-doku
2 |
3 | 
4 |
5 | A command line sudoku game written in C. It can generate new games, solve games, validate games, and tell if there is a single solution to a game (thus validating new games). The game itself uses the [ncurses](https://www.gnu.org/software/ncurses/) library, and the tests rely on [cmocka](https://cmocka.org/).
6 |
7 | ## Installation
8 | The included makefile should be able to compile the c files into a working binary, simply run `make`. To run the tests run `make tests` and then `make check`. Once the binary is generated you can move it to somewhere in your path and then execute `c-doku`, or run it from its directory with `./c-doku`. This has only been tested on Linux, adjustments may be needed for it to work on Windows and OSX.
9 |
10 | ## Usage
11 | There are no mandatory arguments when running c-doku, however there is an optional argument for difficulty level. By defauly c-doku opens with a difficulty level of medium, but easy and hard can also be specified.
12 |
13 | | Command | Pre-filled squares |
14 | |:------------------------------|:-------------------------------------------------------------------|
15 | | `c-doku easy` | 40 |
16 | | `c-doku medium` | 35 |
17 | | `c-doku hard` | 30 |
18 |
19 | When saving, the game will be stored in the ~/.grid.cdoku file. When reopening the application, C-doku will try to find your saved grid in this file, and if there is no grid present, it will start with a new grid.
20 | The -h and --help arguments will display a short help message.
21 |
22 | ## Keybindings
23 | C-doku has vim-like keybindings. See the image or table below.
24 |
25 | 
26 |
27 | | Key | Action |
28 | |:------------------------------|:-------------------------------------------------------------------|
29 | |`h / ←` | Move left |
30 | |`j / ↓` | Move down |
31 | |`k / ↑` | Move up |
32 | |`l / →` | Move right |
33 | |`^` | Beginning of row |
34 | |`&` | End of row |
35 | |`g` | Top of column |
36 | |`G` | Bottom of column |
37 | |`tab` | Next box |
38 | |`return` | 1 box below |
39 | |`G` | Bottom of column |
40 | |`w` | Save |
41 | |`q` | Quit |
42 | |`n` | New grid |
43 | |`f` | New completed grid |
44 | |`x` | Clear grid |
45 | |`s` | Solve |
46 | |`v` | Validate |
47 | |`u` | Undo |
48 | |`r` | Redo |
49 | |`d` | Delete |
50 | |`c` | Complete / incomplete |
51 | |`m` | Multiple solutions |
52 | |`e` | All squares editable |
53 | |`o` | All filled squares locked |
54 | |`space` | Clear message |
55 |
--------------------------------------------------------------------------------
/c-doku.c:
--------------------------------------------------------------------------------
1 | #include
2 | #include
3 | #include
4 | #include
5 | #include
6 | #include
7 | #include "sudoku.h"
8 | #include "interface.h"
9 |
10 |
11 | bool save_grid(Grid* grid, char* grid_file_path) {
12 | FILE *grid_file = fopen(grid_file_path, "w");
13 | if (grid_file == NULL) {
14 | printw("Error saving grid!\n");
15 | return false;
16 | }
17 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
18 | fprintf(grid_file, "%d", grid->values[grid_i]);
19 | }
20 | fprintf(grid_file, "\n");
21 | for (int grid_j = 0; grid_j < GRID_SIZE; grid_j++) {
22 | fprintf(grid_file, "%d", grid->square_type[grid_j]);
23 | }
24 | fclose(grid_file);
25 | return true;
26 | }
27 |
28 |
29 | bool open_grid(Grid* grid, char* grid_file_path) {
30 | FILE *grid_file = fopen(grid_file_path, "r");
31 | if (grid_file == NULL) {
32 | return false;
33 | }
34 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
35 | fscanf(grid_file, "%1d", &grid->values[grid_i]);
36 | }
37 | for (int grid_j = 0; grid_j < GRID_SIZE; grid_j++) {
38 | fscanf(grid_file, "%1d", &grid->square_type[grid_j]);
39 | }
40 | fclose(grid_file);
41 | return true;
42 | }
43 |
44 |
45 | typedef struct Grids {
46 | Grid* grid;
47 | Grid* undo_grid;
48 | Grid* redo_grid;
49 | int* undo_level;
50 | } Grids;
51 |
52 |
53 | void store_undo(Grids grids) {
54 | *grids.undo_level = 0;
55 | replace_grid(grids.grid, grids.undo_grid);
56 | }
57 |
58 |
59 | void undo(Grids grids) {
60 | if (*grids.undo_level >= 0) {
61 | *grids.undo_level = -1;
62 | replace_grid(grids.grid, grids.redo_grid);
63 | replace_grid(grids.undo_grid, grids.grid);
64 | }
65 | }
66 |
67 |
68 | void redo(Grids grids) {
69 | if (*grids.undo_level <= 0) {
70 | *grids.undo_level = 1;
71 | replace_grid(grids.grid, grids.undo_grid);
72 | replace_grid(grids.redo_grid, grids.grid);
73 | }
74 | }
75 |
76 | int main(int argc, char *argv[]){
77 |
78 |
79 | /* Display a help message if the -h option is specified */
80 | if (argc > 1 && (strcmp(argv[1], "-h") == 0 || strcmp(argv[1], "--help") == 0)) {
81 | print_help_message();
82 | return 0;
83 | }
84 |
85 |
86 | /* Setup for ncurses and random number generation */
87 | srand(time(NULL));
88 | initscr();
89 | cbreak();
90 | noecho();
91 | keypad(stdscr, TRUE);
92 | start_color();
93 | use_default_colors();
94 | init_pair(0, COLOR_WHITE, COLOR_BLACK);
95 | init_pair(1, COLOR_CYAN, COLOR_BLACK);
96 | init_pair(2, COLOR_MAGENTA, COLOR_BLACK);
97 |
98 |
99 | /* Setup for the grid file */
100 | char* grid_file_path;
101 | char* grid_file_name = "/.grid.cdoku";
102 | grid_file_path = malloc(strlen(getenv("HOME")) + strlen(grid_file_name) + 1);
103 | strcpy(grid_file_path, getenv("HOME"));
104 | strcat(grid_file_path, grid_file_name);
105 |
106 |
107 | /* The key pressed by the user and its integer representation */
108 | char c;
109 | int c_int;
110 | int filled = 35;
111 |
112 |
113 | Position position = { .x = 0, .y = 0 };
114 | Grid* grid = new_blank_grid();
115 | Grid* undo_grid = new_blank_grid();
116 | Grid* redo_grid = new_blank_grid();
117 | int undo_level = 0;
118 | Grids grids = { .grid = grid, .undo_grid = undo_grid, .redo_grid = redo_grid, .undo_level = &undo_level };
119 |
120 |
121 | bool existing_grid = open_grid(grid, grid_file_path);
122 | store_undo(grids);
123 | print_grid(grid);
124 |
125 |
126 | /* If a difficulty level has been specified */
127 | if(argc > 1 && strcmp(argv[1], "easy") == 0) {
128 | filled = 40;
129 | } else if(argc > 1 && strcmp(argv[1], "medium") == 0) {
130 | filled = 35;
131 | } else if(argc > 1 && strcmp(argv[1], "hard") == 0) {
132 | filled = 30;
133 | }
134 |
135 |
136 | if (existing_grid == false) {
137 | new_game(grid, filled);
138 | }
139 | print_grid(grid);
140 | make_move(0, 0, &position);
141 | if (existing_grid == true) {
142 | print_message("SAVED GRID OPENED", &position);
143 | } else {
144 | print_message("NEW GAME", &position);
145 | }
146 |
147 |
148 | while((c = getch()) != 'q') {
149 | switch(c) {
150 | case 4:
151 | case 'h':
152 | make_move(-1, 0, &position);
153 | break;
154 | case 2:
155 | case 'j':
156 | make_move(0, 1, &position);
157 | break;
158 | case 3:
159 | case 'k':
160 | make_move(0, -1, &position);
161 | break;
162 | case 5:
163 | case 'l':
164 | make_move(1, 0, &position);
165 | break;
166 | case 'w':
167 | save_grid(grid, grid_file_path);
168 | print_message("SAVED", &position);
169 | break;
170 | case 'f':
171 | store_undo(grids);
172 | new_complete_grid(grid);
173 | print_grid(grid);
174 | print_message("NEW COMPLETED GRID", &position);
175 | break;
176 | case 'n':
177 | store_undo(grids);
178 | new_game(grid, filled);
179 | print_grid(grid);
180 | print_message("NEW GAME", &position);
181 | break;
182 | case 's':
183 | if(is_grid_valid(grid) == false) {
184 | print_message("INVALID", &position);
185 | } else {
186 | store_undo(grids);
187 | if (solve_game(grid) == true) {
188 | print_grid(grid);
189 | print_message("SOLVED", &position);
190 | } else {
191 | print_grid(grid);
192 | print_message("CANNOT SOLVE", &position);
193 | }
194 | }
195 | break;
196 | case 'm':
197 | if(is_grid_valid(grid) == false) {
198 | print_message("INVALID", &position);
199 | } else if (single_solution(*grid) == true) {
200 | print_message("SINGLE SOLUTION", &position);
201 | } else {
202 | print_message("MULTIPLE SOLUTIONS", &position);
203 | }
204 | break;
205 | case 'x':
206 | store_undo(grids);
207 | clear_grid(grid);
208 | print_grid(grid);
209 | make_move(0, 0, &position);
210 | print_message("GRID CLEARED", &position);
211 | break;
212 | case 'v':
213 | if(is_grid_valid(grid) == true) {
214 | print_message("VALID", &position);
215 | } else {
216 | print_message("INVALID", &position);
217 | }
218 | break;
219 | case 'c':
220 | if(is_grid_valid(grid) == false) {
221 | print_message("INVALID", &position);
222 | } else if(is_grid_complete(grid) == 0) {
223 | print_message("INCOMPLETE", &position);
224 | } else {
225 | print_message("COMPLETE", &position);
226 | }
227 | break;
228 | case 'u':
229 | undo(grids);
230 | print_grid(grid);
231 | make_move(0, 0, &position);
232 | break;
233 | case 'r':
234 | redo(grids);
235 | print_grid(grid);
236 | make_move(0, 0, &position);
237 | break;
238 | case ' ':
239 | print_message("", &position);
240 | break;
241 | case 'd':
242 | store_undo(grids);
243 | add_number(grid, 0, &position);
244 | break;
245 | case '\t':
246 | if (position.x + 3 < 9) {
247 | make_move(3, 0, &position);
248 | } else {
249 | make_move(-6, 3, &position);
250 | }
251 | break;
252 | case '\n':
253 | if (position.y + 3 < 9) {
254 | make_move(0, 3, &position);
255 | } else {
256 | make_move(3, -6, &position);
257 | }
258 | break;
259 | case '^':
260 | make_move(-position.x, 0, &position);
261 | break;
262 | case '$':
263 | make_move(8 - position.x, 0, &position);
264 | break;
265 | case 'g':
266 | make_move(0, -position.y, &position);
267 | break;
268 | case 'G':
269 | make_move(0, 8 - position.y, &position);
270 | break;
271 | case 'e':
272 | store_undo(grids);
273 | editable(grid);
274 | print_grid(grid);
275 | make_move(0, 0, &position);
276 | print_message("EDITABLE", &position);
277 | break;
278 | case 'o':
279 | store_undo(grids);
280 | lock(grid);
281 | print_grid(grid);
282 | make_move(0, 0, &position);
283 | print_message("LOCKED", &position);
284 | break;
285 | default:
286 | c_int = c - '0';
287 | if(c_int >= 0 && c_int <= 9) {
288 | store_undo(grids);
289 | add_number(grid, c_int, &position);
290 | }
291 | break;
292 | }
293 | }
294 |
295 | endwin();
296 |
297 | return 0;
298 | }
299 |
--------------------------------------------------------------------------------
/helpers.c:
--------------------------------------------------------------------------------
1 | #include
2 | #include
3 | #include "sudoku.h"
4 |
5 | int random_in_range(int max) {
6 | unsigned long
7 | num_bins = (unsigned long) max + 1,
8 | num_rand = (unsigned long) RAND_MAX + 1,
9 | bin_size = num_rand / num_bins,
10 | defect = num_rand % num_bins;
11 | long x;
12 | do {
13 | x = rand();
14 | }
15 | while (num_rand - defect <= (unsigned long)x);
16 | return (int) x / bin_size;
17 | }
18 |
19 |
20 | bool group_has_duplicates(Group group) {
21 | for (int j = 0; j < group.count - 1; j++) {
22 | for (int k = j + 1; k < group.count; k++) {
23 | if (group.values[j] == group.values[k] && group.values[j] != 0)
24 | return true;
25 | }
26 | }
27 | return false;
28 | }
29 |
--------------------------------------------------------------------------------
/helpers.h:
--------------------------------------------------------------------------------
1 | #include "sudoku.h"
2 |
3 | #ifndef HELPERS_H_
4 | #define HELPERS_H_
5 |
6 | int random_in_range(int max);
7 |
8 | bool group_has_duplicates(Group group);
9 |
10 | #endif
11 |
--------------------------------------------------------------------------------
/interface.c:
--------------------------------------------------------------------------------
1 | #include
2 | #include
3 | #include "sudoku.h"
4 |
5 | void print_help_message() {
6 | printf("\nUsage:\n");
7 | printf("c-doku [-h/--help] - displays this help message\n");
8 | printf("c-doku - opens saved game, or new medium grid if no file is present\n");
9 | printf("c-soku [easy/medium/hard] - opens a new game with desired difficulty level\n");
10 | printf("\nUseful keybindings:\n");
11 | printf("n - new game\n");
12 | printf("s - solve game\n");
13 | printf("x - clear grid\n");
14 | printf("v - validate grid\n");
15 | printf("c - check if grid is complete\n");
16 | printf("For complete list see README.md\n");
17 | printf("\n");
18 | }
19 |
20 |
21 | void print_divider_row(const chtype left, const chtype middle, const chtype right) {
22 | addch(left);
23 | for (int line_i = 0; line_i < 5; line_i++)
24 | addch(ACS_HLINE);
25 | addch(middle);
26 | for (int line_i = 0; line_i < 5; line_i++)
27 | addch(ACS_HLINE);
28 | addch(middle);
29 | for (int line_i = 0; line_i < 5; line_i++)
30 | addch(ACS_HLINE);
31 | addch(right);
32 | printw("\n");
33 | }
34 |
35 | void print_grid(Grid* grid) {
36 | erase();
37 | print_divider_row(ACS_ULCORNER, ACS_TTEE, ACS_URCORNER);
38 | for (int row_i = 0; row_i < GROUP_SIZE; row_i++) {
39 | addch(ACS_VLINE);
40 | for (int column_i = 0; column_i < GROUP_SIZE; column_i++) {
41 | int grid_position = (row_i * GROUP_SIZE) + column_i;
42 | if (grid->values[grid_position] == 0) {
43 | printw(" ");
44 | } else if (grid->square_type[grid_position] == 0) {
45 | attron(COLOR_PAIR(1));
46 | printw("%d", grid->values[grid_position]);
47 | attroff(COLOR_PAIR(1));
48 | } else if (grid->square_type[grid_position] == 2) {
49 | attron(COLOR_PAIR(2));
50 | printw("%d", grid->values[grid_position]);
51 | attroff(COLOR_PAIR(2));
52 | } else {
53 | printw("%d", grid->values[grid_position]);
54 | }
55 | if ((column_i + 1) % 3 == 0)
56 | addch(ACS_VLINE);
57 | else
58 | printw(" ");
59 | }
60 | printw("\n");
61 | if((row_i + 1) % 3 == 0 && row_i != 8)
62 | print_divider_row(ACS_LTEE, ACS_PLUS, ACS_RTEE);
63 | }
64 | print_divider_row(ACS_LLCORNER, ACS_BTEE, ACS_LRCORNER);
65 | }
66 |
67 |
68 | void make_move(int direction_x, int direction_y, Position* position) {
69 | if (position->x + direction_x >= 0 &&
70 | position->x + direction_x <= GROUP_SIZE - 1 &&
71 | position->y + direction_y >= 0 &&
72 | position->y + direction_y <= GROUP_SIZE - 1)
73 | {
74 | position->x += direction_x;
75 | position->y += direction_y;
76 | move(position->y + 1 + (position->y / 3), (position->x * 2) + 1);
77 | refresh();
78 | }
79 | }
80 |
81 |
82 | void add_number(Grid* grid, int c, Position* position) {
83 | int grid_position = position_on_grid(position);
84 | if (grid->square_type[grid_position] == 0) {
85 | grid->values[grid_position] = c;
86 | print_grid(grid);
87 | make_move(0, 0, position);
88 | }
89 | }
90 |
91 |
92 | void print_message(char* message, Position* position) {
93 | move(14, 0);
94 | clrtoeol();
95 | printw("%s", message);
96 | make_move(0, 0, position);
97 | }
98 |
99 | void editable(Grid* grid) {
100 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
101 | grid->square_type[grid_i] = 0;
102 | }
103 | }
104 |
105 |
106 | void lock(Grid* grid) {
107 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
108 | if (grid->values[grid_i] != 0)
109 | grid->square_type[grid_i] = 1;
110 | }
111 | }
112 |
--------------------------------------------------------------------------------
/interface.h:
--------------------------------------------------------------------------------
1 | #include "sudoku.h"
2 |
3 | #ifndef INTERFACE_FUNCTIONS_H_
4 | #define INTERFACE_FUNCTIONS_H_
5 |
6 | void print_help_message();
7 |
8 | void print_divider_row();
9 |
10 | void print_grid(Grid* grid);
11 |
12 | void make_move(int direction_x, int direction_y, Position* position);
13 |
14 | void add_number(Grid* grid, int c, Position* position);
15 |
16 | void print_message(char* message, Position* position);
17 |
18 | void editable(Grid* grid);
19 |
20 | void lock(Grid* grid);
21 |
22 | #endif
23 |
--------------------------------------------------------------------------------
/sudoku.c:
--------------------------------------------------------------------------------
1 | #include
2 | #include
3 | #include
4 | #include
5 | #include "helpers.h"
6 | #include "sudoku.h"
7 |
8 |
9 | Grid* new_blank_grid() {
10 | Grid* grid = malloc(sizeof(Grid));
11 | clear_grid(grid);
12 | return grid;
13 | }
14 |
15 |
16 | void clear_grid(Grid* grid) {
17 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
18 | grid->values[grid_i] = 0;
19 | grid->blanks[grid_i] = grid_i;
20 | grid->square_type[grid_i] = 0;
21 | }
22 | grid->blank_count = GRID_SIZE;
23 | }
24 |
25 |
26 | void replace_grid(Grid* source_grid, Grid* dest_grid) {
27 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
28 | dest_grid->values[grid_i] = source_grid->values[grid_i];
29 | dest_grid->blanks[grid_i] = source_grid->blanks[grid_i];
30 | dest_grid->square_type[grid_i] = source_grid->square_type[grid_i];
31 | }
32 | dest_grid->blank_count = source_grid->blank_count;
33 | }
34 |
35 |
36 | bool check_rows(Grid* grid) {
37 | for (int row_start = 0; row_start < GRID_SIZE; row_start += GROUP_SIZE) {
38 | Group row = {.values = {0}, .count = 0};
39 | for (int row_item = row_start; row_item < row_start + GROUP_SIZE; row_item++) {
40 | row.values[row.count] = grid->values[row_item];
41 | row.count++;
42 | }
43 | if (group_has_duplicates(row) == true)
44 | return false;
45 | }
46 | return true;
47 | }
48 |
49 |
50 | bool check_cols(Grid* grid) {
51 | for (int col_start = 0; col_start < GROUP_SIZE; col_start++) {
52 | Group col = {.values = {0}, .count = 0};
53 | for (int col_item = col_start; col_item < GRID_SIZE; col_item += GROUP_SIZE) {
54 | col.values[col.count] = grid->values[col_item];
55 | col.count++;
56 | }
57 | if (group_has_duplicates(col) == true)
58 | return false;
59 | }
60 | return true;
61 | }
62 |
63 |
64 | bool check_boxes(Grid* grid) {
65 | Group box = {.values = {0}, .count = 0};
66 | for (int box_i = 0; box_i < 27; box_i++) {
67 | int box_x = ((box_i / GROUP_SIZE) * 3) + (box_i % 3);
68 | for (int box_j = 0; box_j < 3; box_j++) {
69 | Position position = {.x = box_x, .y = ((box_i % GROUP_SIZE) / 3) * 3 + box_j};
70 | box.values[box.count] = get_grid_value(grid, &position);
71 | box.count++;
72 | if(box.count == GROUP_SIZE) {
73 | if (group_has_duplicates(box) == true) {
74 | return false;
75 | } else {
76 | memset(box.values, 0, GROUP_SIZE * sizeof(int));
77 | box.count = 0;
78 | }
79 | }
80 | }
81 | }
82 | return true;
83 | }
84 |
85 |
86 | bool is_grid_valid(Grid* grid) {
87 | return check_rows(grid) && check_cols(grid) && check_boxes(grid);
88 | }
89 |
90 |
91 | bool is_grid_complete(Grid* grid) {
92 | set_blanks(grid);
93 | return grid->blank_count == 0;
94 | }
95 |
96 |
97 | int find_random_valid_entry(Grid* grid, int square) {
98 | int tried[GROUP_SIZE] = {0};
99 | int tried_count = 0;
100 | while(tried_count <= 8) {
101 | int rand_int = random_in_range(8);
102 | if (tried[rand_int] == 0) {
103 | tried[rand_int] = 1;
104 | tried_count++;
105 | grid->values[square] = rand_int + 1;
106 | if (is_grid_valid(grid) == true) {
107 | return rand_int + 1;
108 | }
109 | }
110 | }
111 | grid->values[square] = 0;
112 | return 0;
113 | }
114 |
115 |
116 | int find_incremented_valid_entry(Grid* grid, int square, int start) {
117 | int val = start + 1;
118 | while(val <= GROUP_SIZE) {
119 | grid->values[square] = val;
120 | if (is_grid_valid(grid) == true) {
121 | return val;
122 | } else {
123 | val++;
124 | }
125 | }
126 | grid->values[square] = 0;
127 | return 0;
128 | }
129 |
130 |
131 | void new_complete_grid(Grid* grid) {
132 | clear_grid(grid);
133 | int i = 0;
134 | int last_backtrack = 0;
135 | while(i < GRID_SIZE) {
136 | int entry = find_random_valid_entry(grid, i);
137 | if (entry) {
138 | grid->square_type[i] = 1;
139 | i++;
140 | } else {
141 | i = (i / GROUP_SIZE) * GROUP_SIZE;
142 | if(i == last_backtrack && i >= GROUP_SIZE)
143 | i -= GROUP_SIZE;
144 | for (int grid_i = i; grid_i < GRID_SIZE; grid_i++)
145 | grid->values[grid_i] = 0;
146 | last_backtrack = i;
147 | }
148 | }
149 | grid->blank_count = 0;
150 | }
151 |
152 |
153 | void new_game(Grid* grid, int filled) {
154 | new_complete_grid(grid);
155 | while(grid->blank_count < GRID_SIZE - filled) {
156 | int random_to_remove = random_in_range(80);
157 | if (grid->values[random_to_remove]) {
158 | int removed = grid->values[random_to_remove];
159 | grid->values[random_to_remove] = 0;
160 | grid->square_type[random_to_remove] = 0;
161 | grid->blank_count++;
162 | if (single_solution(*grid) == false) {
163 | grid->values[random_to_remove] = removed;
164 | grid->square_type[random_to_remove] = 1;
165 | grid->blank_count--;
166 | }
167 | }
168 | }
169 | }
170 |
171 |
172 | bool solve_game(Grid* grid) {
173 | set_blanks(grid);
174 | return find_solution(grid, 0);
175 | }
176 |
177 |
178 | bool find_solution(Grid* grid, int current_blank) {
179 | if (current_blank >= grid->blank_count)
180 | return true;
181 | int current_square = grid->blanks[current_blank];
182 | int entry = find_incremented_valid_entry(grid, current_square, grid->values[current_square]);
183 | if (entry != 0) {
184 | grid->square_type[current_square] = 2;
185 | return find_solution(grid, current_blank + 1);
186 | } else if(entry == 0 && current_blank > 0) {
187 | grid->square_type[current_square] = 0;
188 | return find_solution(grid, current_blank - 1);
189 | }
190 | return false;
191 | }
192 |
193 |
194 | void set_blanks(Grid* grid) {
195 | grid->blank_count = 0;
196 | for (int grid_i = 0; grid_i < GRID_SIZE; grid_i++) {
197 | if (grid->values[grid_i] == 0) {
198 | grid->blanks[grid->blank_count] = grid_i;
199 | grid->blank_count++;
200 | }
201 | }
202 | }
203 |
204 |
205 | bool single_solution(Grid grid) {
206 | solve_game(&grid);
207 | grid.values[grid.blanks[grid.blank_count - 1]] = 0;
208 | bool retry = find_solution(&grid, grid.blank_count - 2);
209 | return retry == false;
210 | }
211 |
212 |
213 | int get_grid_value(Grid* grid, Position* position) {
214 | return grid->values[position_on_grid(position)];
215 | }
216 |
217 |
218 | int position_on_grid(Position* position) {
219 | return (position->y * GROUP_SIZE) + position->x;
220 | }
221 |
--------------------------------------------------------------------------------
/sudoku.h:
--------------------------------------------------------------------------------
1 | #include
2 |
3 | #ifndef SUDOKU_FUNCTIONS_H_
4 | #define SUDOKU_FUNCTIONS_H_
5 |
6 | #define GRID_SIZE 81
7 | #define GROUP_SIZE 9
8 |
9 | typedef struct Position {
10 | int x;
11 | int y;
12 | } Position;
13 |
14 | typedef struct Movement {
15 | int x;
16 | int y;
17 | } Movement;
18 |
19 | typedef struct Grid {
20 | int values[GRID_SIZE];
21 | int blanks[GRID_SIZE];
22 | int square_type[GRID_SIZE]; /* 0 is blank, 1 is pre-filled and 2 is solved by the application */
23 | int blank_count;
24 | } Grid;
25 |
26 | typedef struct Group {
27 | int values[GROUP_SIZE];
28 | int count;
29 | } Group;
30 |
31 | Grid* new_blank_grid();
32 |
33 | void clear_grid(Grid* grid);
34 |
35 | void replace_grid(Grid* source_grid, Grid* dest_grid);
36 |
37 | bool check_rows(Grid* grid);
38 |
39 | bool check_cols(Grid* grid);
40 |
41 | bool check_boxes(Grid* grid);
42 |
43 | bool is_grid_valid(Grid* grid);
44 |
45 | bool is_grid_complete(Grid* grid);
46 |
47 | int find_random_valid_entry(Grid* grid, int square);
48 |
49 | int find_incremented_valid_entry(Grid* grid, int square, int start);
50 |
51 | void new_complete_grid(Grid* grid);
52 |
53 | void new_game(Grid* grid, int filled);
54 |
55 | bool solve_game(Grid* grid);
56 |
57 | bool find_solution(Grid* grid, int current_blank);
58 |
59 | void set_blanks(Grid* grid);
60 |
61 | bool single_solution(Grid grid);
62 |
63 | int num_solutions(Grid* grid, int current, int solutions);
64 |
65 | int get_grid_value(Grid* grid, Position* position);
66 |
67 | int position_on_grid(Position* postion);
68 |
69 | #endif
70 |
--------------------------------------------------------------------------------
/tests.c:
--------------------------------------------------------------------------------
1 | #include
2 | #include
3 | #include
4 | #include
5 | #include
6 | #include "helpers.h"
7 | #include "sudoku.h"
8 |
9 | /* Test helpers */
10 |
11 | void test_random_in_range() {
12 | int random = random_in_range(20);
13 | assert_in_range(random, 0, 20);
14 | }
15 |
16 | void test_group_has_duplicates() {
17 | Group group1 = { .values = {1, 2, 3, 4, 5, 6, 7, 8, 9}, .count = 9 };
18 | assert_false(group_has_duplicates(group1));
19 | Group group2 = { .values = {1, 2, 3, 4, 5, 5, 7, 8, 9}, .count = 9 };
20 | assert_true(group_has_duplicates(group2));
21 | }
22 |
23 | /* Test sudoku */
24 |
25 | int blank_grid[81] = {0, 0, 0, 0, 0, 0, 0, 0, 0,
26 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
27 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
28 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
29 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
30 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
31 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
32 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
33 | 0, 0, 0, 0, 0, 0, 0, 0, 0};
34 |
35 | int complete_valid_grid[81] = {1, 2, 3, 4, 5, 6, 7, 8, 9,
36 | 4, 5, 6, 7, 8, 9, 1, 2, 3,
37 | 7, 8, 9, 1, 2, 3, 4, 5, 6,
38 | 2, 1, 4, 3, 6, 5, 8, 9, 7,
39 | 3, 6, 5, 8, 9, 7, 2, 1, 4,
40 | 8, 9, 7, 2, 1, 4, 3, 6, 5,
41 | 5, 3, 1, 6, 4, 2, 9, 7, 8,
42 | 6, 4, 2, 9, 7, 8, 5, 3, 1,
43 | 9, 7, 8, 5, 3, 1, 6, 4, 2};
44 |
45 | int incomplete_valid_grid[81] = {0, 2, 3, 4, 5, 6, 7, 8, 9,
46 | 4, 5, 6, 7, 8, 9, 1, 2, 3,
47 | 7, 8, 9, 1, 2, 3, 4, 5, 6,
48 | 2, 1, 4, 3, 6, 5, 8, 9, 7,
49 | 3, 6, 5, 8, 9, 7, 2, 1, 4,
50 | 8, 9, 7, 2, 1, 4, 3, 6, 5,
51 | 5, 3, 1, 6, 4, 2, 9, 7, 8,
52 | 6, 4, 2, 9, 7, 8, 5, 3, 1,
53 | 9, 7, 8, 5, 3, 1, 6, 4, 0};
54 |
55 | int single_solution_game[81] = {7, 0, 1, 0, 5, 0, 0, 4, 0,
56 | 0, 2, 5, 3, 0, 0, 8, 0, 1,
57 | 0, 0, 4, 6, 0, 9, 0, 7, 5,
58 | 0, 7, 3, 9, 8, 0, 5, 1, 0,
59 | 0, 0, 2, 0, 0, 0, 4, 0, 0,
60 | 0, 0, 0, 0, 0, 1, 6, 3, 7,
61 | 8, 4, 0, 0, 0, 0, 0, 0, 0,
62 | 0, 0, 0, 2, 0, 0, 1, 6, 0,
63 | 2, 0, 6, 0, 0, 3, 0, 0, 8};
64 |
65 | int multiple_solution_game[81] = {0, 0, 0, 0, 5, 0, 0, 4, 0,
66 | 0, 2, 5, 3, 0, 0, 8, 0, 1,
67 | 0, 0, 4, 6, 0, 9, 0, 7, 5,
68 | 0, 7, 3, 9, 8, 0, 5, 1, 0,
69 | 0, 0, 2, 0, 0, 0, 4, 0, 0,
70 | 0, 0, 0, 0, 0, 1, 6, 3, 7,
71 | 8, 4, 0, 0, 0, 0, 0, 0, 0,
72 | 0, 0, 0, 2, 0, 0, 1, 6, 0,
73 | 2, 0, 6, 0, 0, 3, 0, 0, 8};
74 |
75 | int bad_rows_grid[81] = {0, 0, 1, 1, 0, 0, 0, 0, 0,
76 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
77 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
78 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
79 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
80 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
81 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
82 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
83 | 0, 0, 0, 0, 0, 0, 0, 0, 0};
84 |
85 | int bad_cols_grid[81] = {0, 0, 1, 0, 0, 0, 0, 0, 0,
86 | 0, 0, 1, 0, 0, 0, 0, 0, 0,
87 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
88 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
89 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
90 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
91 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
92 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
93 | 0, 0, 0, 0, 0, 0, 0, 0, 0};
94 |
95 | int bad_boxes_grid[81] = {1, 0, 0, 0, 0, 0, 0, 0, 0,
96 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
97 | 0, 0, 1, 0, 0, 0, 0, 0, 0,
98 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
99 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
100 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
101 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
102 | 0, 0, 0, 0, 0, 0, 0, 0, 0,
103 | 0, 0, 0, 0, 0, 0, 0, 0, 0};
104 |
105 | void test_new_blank_grid() {
106 | Grid* grid = new_blank_grid();
107 | assert_int_equal(grid->values[0], 0);
108 | assert_int_equal(grid->values[80], 0);
109 | assert_int_equal(grid->blanks[0], 0);
110 | assert_int_equal(grid->blanks[80], 80);
111 | assert_int_equal(grid->blank_count, 81);
112 | }
113 |
114 | void test_check_rows() {
115 | Grid grid;
116 | memcpy(grid.values, bad_rows_grid, sizeof(bad_rows_grid));
117 | assert_false(check_rows(&grid));
118 | Grid grid2;
119 | memcpy(grid2.values, complete_valid_grid, sizeof(complete_valid_grid));
120 | assert_true(check_rows(&grid2));
121 | }
122 |
123 | void test_check_cols() {
124 | Grid grid;
125 | memcpy(grid.values, bad_cols_grid, sizeof(bad_rows_grid));
126 | assert_false(check_cols(&grid));
127 | Grid grid2;
128 | memcpy(grid2.values, complete_valid_grid, sizeof(complete_valid_grid));
129 | assert_true(check_cols(&grid2));
130 | }
131 |
132 | void test_check_boxes() {
133 | Grid grid;
134 | memcpy(grid.values, bad_boxes_grid, sizeof(bad_boxes_grid));
135 | assert_false(check_boxes(&grid));
136 | Grid grid2;
137 | memcpy(grid2.values, complete_valid_grid, sizeof(complete_valid_grid));
138 | assert_true(check_boxes(&grid2));
139 | }
140 |
141 | void test_is_grid_valid() {
142 | Grid grid;
143 | memcpy(grid.values, bad_boxes_grid, sizeof(bad_boxes_grid));
144 | assert_false(is_grid_valid(&grid));
145 | Grid grid2;
146 | memcpy(grid2.values, complete_valid_grid, sizeof(complete_valid_grid));
147 | assert_true(is_grid_valid(&grid2));
148 | }
149 |
150 | void test_is_grid_complete() {
151 | Grid grid;
152 | memcpy(grid.values, incomplete_valid_grid, sizeof(bad_boxes_grid));
153 | assert_false(is_grid_complete(&grid));
154 | Grid grid2;
155 | memcpy(grid2.values, complete_valid_grid, sizeof(complete_valid_grid));
156 | assert_true(is_grid_complete(&grid2));
157 | }
158 |
159 | void test_find_random_valid_entry() {
160 | Grid grid;
161 | memcpy(grid.values, incomplete_valid_grid, sizeof(incomplete_valid_grid));
162 | int val = find_random_valid_entry(&grid, 80);
163 | assert_int_equal(val, 2);
164 | }
165 |
166 | void test_find_incremented_valid_entry() {
167 | Grid grid;
168 | memcpy(grid.values, complete_valid_grid, sizeof(complete_valid_grid));
169 | int val = find_incremented_valid_entry(&grid, 80, 2);
170 | assert_int_equal(val, 0);
171 | Grid grid2;
172 | memcpy(grid2.values, blank_grid, sizeof(blank_grid));
173 | int val2 = find_incremented_valid_entry(&grid2, 0, 0);
174 | assert_int_equal(val2, 1);
175 | }
176 |
177 | void test_new_complete_grid() {
178 | Grid* grid = new_blank_grid();
179 | new_complete_grid(grid);
180 | assert_true(is_grid_valid(grid));
181 | assert_true(is_grid_complete(grid));
182 | int total = 0;
183 | for (int grid_i = 0; grid_i < 81; grid_i++) {
184 | total += grid->values[grid_i];
185 | }
186 | assert_int_equal(total, 405);
187 | }
188 |
189 | void test_new_game() {
190 | Grid* grid = new_blank_grid();
191 | new_game(grid, 35);
192 | set_blanks(grid);
193 | assert_true(is_grid_valid(grid));
194 | assert_int_equal(grid->blank_count, 46);
195 | }
196 |
197 | void test_solve_game() {
198 | Grid* grid = new_blank_grid();
199 | memcpy(grid->values, incomplete_valid_grid, sizeof(incomplete_valid_grid));
200 | solve_game(grid);
201 | assert_int_equal(grid->values[0], 1);
202 | assert_int_equal(grid->values[80], 2);
203 | }
204 |
205 | void test_find_solution() {
206 | Grid* grid = new_blank_grid();
207 | memcpy(grid->values, incomplete_valid_grid, sizeof(incomplete_valid_grid));
208 | set_blanks(grid);
209 | find_solution(grid, 0);
210 | assert_int_equal(grid->values[0], 1);
211 | assert_int_equal(grid->values[80], 2);
212 | Grid grid2;
213 | memcpy(grid2.values, bad_boxes_grid, sizeof(bad_boxes_grid));
214 | set_blanks(&grid2);
215 | assert_false(find_solution(&grid2, 0));
216 | }
217 |
218 | void test_set_blanks() {
219 | Grid* grid = new_blank_grid();
220 | memcpy(grid->values, incomplete_valid_grid, sizeof(incomplete_valid_grid));
221 | set_blanks(grid);
222 | assert_int_equal(grid->blank_count, 2);
223 | assert_int_equal(grid->blanks[0], 0);
224 | assert_int_equal(grid->blanks[1], 80);
225 | }
226 |
227 | void test_single_solution() {
228 | Grid* grid = new_blank_grid();
229 | memcpy(grid->values, single_solution_game, sizeof(single_solution_game));
230 | assert_true(single_solution(*grid));
231 | Grid* grid2 = new_blank_grid();
232 | memcpy(grid2->values, multiple_solution_game, sizeof(multiple_solution_game));
233 | assert_false(single_solution(*grid2));
234 | }
235 |
236 | void test_get_grid_value() {
237 | Position pos = { .x = 2, .y = 3 };
238 | Grid* grid = new_blank_grid();
239 | memcpy(grid->values, complete_valid_grid, sizeof(complete_valid_grid));
240 | assert_int_equal(get_grid_value(grid, &pos), 4);
241 | }
242 |
243 | void test_position_on_grid() {
244 | Position pos = { .x = 2, .y = 3 };
245 | assert_int_equal(position_on_grid(&pos), 29);
246 | }
247 |
248 | int main(void) {
249 | const struct CMUnitTest tests[] = {
250 | cmocka_unit_test(test_random_in_range),
251 | cmocka_unit_test(test_group_has_duplicates),
252 | cmocka_unit_test(test_new_blank_grid),
253 | cmocka_unit_test(test_check_rows),
254 | cmocka_unit_test(test_check_cols),
255 | cmocka_unit_test(test_check_boxes),
256 | cmocka_unit_test(test_is_grid_valid),
257 | cmocka_unit_test(test_is_grid_complete),
258 | cmocka_unit_test(test_find_random_valid_entry),
259 | cmocka_unit_test(test_find_incremented_valid_entry),
260 | cmocka_unit_test(test_new_complete_grid),
261 | cmocka_unit_test(test_new_game),
262 | cmocka_unit_test(test_solve_game),
263 | cmocka_unit_test(test_find_solution),
264 | cmocka_unit_test(test_set_blanks),
265 | cmocka_unit_test(test_single_solution),
266 | cmocka_unit_test(test_get_grid_value),
267 | cmocka_unit_test(test_position_on_grid),
268 | };
269 | return cmocka_run_group_tests(tests, NULL, NULL);
270 | }
271 |
--------------------------------------------------------------------------------