├── .gitignore
├── LICENSE
├── README.md
├── main.cpp
└── media
├── image1.png
├── image2.png
└── image3.png
/.gitignore:
--------------------------------------------------------------------------------
1 | .vscode/
2 | html/
3 | test*
4 | main
5 | TODO.md
6 | *.txt
7 | *.docx
8 | *.pdf
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # File Management System
2 |
3 | **Table of Contents**
4 | - [Defining the Problem Statement:](#defining-the-problem-statement)
5 | - [Selecting the Data Structure:](#selecting-the-data-structure)
6 | - [Execution of Solution:](#execution-of-solution)
7 | - [Algorithms](#algorithms)
8 | - [print_tree(root, prev_struct)](#print_treeroot-prev_struct)
9 | - [print_ls(node=pwd->child)](#print_lsnodepwd-child)
10 | - [pwd_str(root, pwd)](#pwd_strroot-pwd)
11 | - [find_names(root, pwd, name)](#find_namesroot-pwd-name)
12 | - [find_on_pwd(pwd, name)](#find_on_pwdpwd-name)
13 | - [find_node(root, pwd, path)](#find_noderoot-pwd-path)
14 | - [cd(root, pwd, path)](#cdroot-pwd-path)
15 | - [create(root, pwd, path, type)](#createroot-pwd-path-type)
16 | - [remove(root, pwd, path)](#removeroot-pwd-path)
17 | - [dupl(root, pwd, src_path, dst_path, keep)](#duplroot-pwd-src_path-dst_path-keep)
18 | - [cat(root, pwd, path)](#catroot-pwd-path)
19 | - [edit(root, pwd, path)](#editroot-pwd-path)
20 | - [chmod(root, pwd, path, new_modes)](#chmodroot-pwd-path-new_modes)
21 | - [Dry Run](#dry-run)
22 |
23 | ## Defining the Problem Statement:
24 |
25 | Data on every Operating System is stored in a hierarchical file system
26 | constituted of directories and subdirectories beneath them. A file
27 | management system is the program used to arrange these files, move them,
28 | and create / delete them. This take care of how the files are organized
29 | rather than how they are stored.
30 |
31 | The key features are to:
32 |
33 | - Create, modify, move, copy, delete and other file operations.
34 |
35 | - Add or edit basic metadata.
36 |
37 | ## Selecting the Data Structure:
38 |
39 | Trees would be the best suited data structure to implement this because
40 | nodes and leaves of the tree resemble the directories and
41 | sub-directories containing files in them.
42 |
43 | A binary tree cannot do the job here as it restricts to only having two
44 | children. N-ary Tree should be implemented solve this. Since we do not
45 | know what will be the value of n, each node cannot have a fixed child
46 | links.
47 |
48 | 
49 |
50 | But if we think this as keeping the contents of a directory as a linked
51 | list and only storing the first child’s address, then each node can have
52 | exactly 2 links. This makes it possible to use algorithms of Binary Tree
53 | as well.
54 |
55 | 
56 |
57 | There is also a need to traverse upwards to its root. This can be solved
58 | by creating another link with the parent directory. Although this
59 | technically becomes a Graph, but implementation will be like a binary
60 | tree in a broad level and like linked list in a directory level.
61 |
62 | 
63 |
64 | ## Execution of Solution:
65 |
66 | The execution is very much inspired from Linux shell. The program
67 | resembles the shell which contains the present working directory on left
68 | and prompt at end. The user can use following commands just like in the
69 | Linux shell. Some key commands are:
70 |
71 | - **cd** - to navigate through directories
72 |
73 | - **ls** - to list the files and sub-directories in a directory
74 |
75 | - **tree** – to view a tree structure of what is inside a directory
76 | until the last file
77 |
78 | - **mkdir** – to create a new directory
79 |
80 | - **touch** – to create a new file
81 |
82 | - **edit** – to edit the file contents
83 |
84 | - **rm** / **rmdir** – to remove a file / directory respectively
85 |
86 | - **cp** / **mv** – to copy / move a file or directory respectively
87 |
88 | - **find** – to find files or directories
89 |
90 | Examples:
91 |
92 | ```bash
93 | cd /home/user
94 | ls
95 | tree /
96 | touch prog1.c
97 | edit prog1.c
98 | mkdir c_programs
99 | mv prog1.c c_programs/
100 | ```
101 |
102 | The input is taken as list of strings and appropriate functions are
103 | called along with the arguments (i.e., path or name) passed. Since the
104 | argument can be with respect to **root** or **pwd**, these 2 pointer
105 | variables are necessary in the main function. In case of path, each
106 | separate functions should **cd** into that path and run the operations.
107 |
108 | - Creation will just be like adding a node at end of linked list.
109 |
110 | - Deletion will just be like deleting a node from linked list.
111 |
112 | - Traversal will just be like traversing binary tree in pre-order.
113 |
114 |
115 | ## Algorithms
116 |
117 | **Structure of a node**:
118 |
119 | >string name
120 | list content
121 | char type
122 | string create_time
123 | string modify_time
124 | int perm
125 | node pointer link
126 | node pointer child
127 | node pointer parent
128 |
129 | **n** = Total number of nodes ; **m** = number of nodes in a directory ; **h** = height of tree
130 |
131 | ---
132 | ### print_tree(root, prev_struct)
133 | This algorithm prints all node names from root in a form of tree
134 | ```python
135 | START
136 | 1. if (root is not null)
137 | set struct to prev_struct+branch
138 | print struct+name
139 | print_tree(root->child, struct)
140 | print_tree(root->link, prev_struct)
141 | end if
142 | STOP
143 | ```
144 | > Time Complexity = O(n)
145 | Auxiliary Space = O(n)
146 |
147 | ---
148 | ### print_ls(node=pwd->child)
149 | This algorithm prints all node name in a directory
150 | ```python
151 | START
152 | 1. if (node in not null)
153 | print name
154 | print_ls(node->link)
155 | end if
156 | STOP
157 | ```
158 | > Time Complexity = O(m)
159 | Auxiliary Space = O(1)
160 |
161 | ---
162 | ### pwd_str(root, pwd)
163 | This algorithm returns the complete path of a node with respect to root
164 | ```python
165 | START
166 | 1. set path to empty string
167 | 2. if (pwd is root)
168 | return “/”
169 | end if
170 | 3. loop (while pwd is not root)
171 | set path to “/”+name+path
172 | set pwd to pwd->parent
173 | end loop
174 | 4. return path
175 | STOP
176 | ```
177 | > Time Complexity = O(h)
178 | Auxiliary Space = O(h)
179 |
180 | ---
181 | ### find_names(root, pwd, name)
182 | This algorithm returns the complete list of all nodes' path containing a given string
183 | ```python
184 | START
185 | 1. declare static list of string result
186 | 2. if (root is pwd)
187 | clear result
188 | end if
189 | 3. if (pwd is not null)
190 | set path to pwd_str(root, pwd)
191 | if (name in path)
192 | push path into end of result
193 | end if
194 | find_names(root, pwd->child, name)
195 | find_names(root, pwd->link, name)
196 | end if
197 | 4. return result
198 | STOP
199 | ```
200 | > Time Complexity = O(n*h)
201 | Auxiliary Space = O(n)
202 |
203 | ---
204 | ### find_on_pwd(pwd, name)
205 | This algorithm returns the node of desired name on present working directory
206 | ```python
207 | START
208 | 1. set pwd to pwd->child
209 | 2. loop (while pwd is not null)
210 | if (both names are same)
211 | return pwd
212 | end if
213 | set pwd to pwd->link
214 | 3. return null
215 | STOP
216 | ```
217 | > Time Complexity = O(m)
218 | Auxiliary Space = O(1)
219 |
220 | ---
221 | ### find_node(root, pwd, path)
222 | This algorithm returns the node of desired path with respect to root or pwd
223 | ```python
224 | START
225 | 1. get parent_path and name from path
226 | 2. set pwd to cd(root, pwd, parent_path)
227 | 3. if (pwd in null) return null
228 | 4. return find_on_pwd(pwd, name)
229 | STOP
230 | ```
231 | > Time Complexity = O(m*h)
232 | Auxiliary Space = O(1)
233 |
234 | ---
235 | ### cd(root, pwd, path)
236 | This algorithm returns the directory of desired path with respect to root or pwd
237 | ```python
238 | START
239 | 1. set path_list to split(path, '/')
240 | 2. if (path_list[0] is empty string)
241 | set node to root
242 | pop first element from path_list
243 | else if (path_list[0] = ".")
244 | if (length of path_list is 1)
245 | return pwd
246 | else
247 | set node to pwd
248 | pop first element from path_list
249 | end if
250 | else if (path_list[0] = "..")
251 | if (length of path_list is 1)
252 | return pwd->parent
253 | else
254 | set node to pwd->parent
255 | pop first element from path_list
256 | else
257 | set node to pwd
258 | end if
259 | 3. loop (for each element in path_list)
260 | set node to find_on_pwd(node, element)
261 | if (node is not null or node is not a directory)
262 | print path does not exist
263 | return null
264 | end if
265 | end loop
266 | 4. return node
267 | STOP
268 | ```
269 | > Time Complexity = O(m*h)
270 | Auxiliary Space = O(h)
271 |
272 | ---
273 | ### create(root, pwd, path, type)
274 | This algorithm creates and returns a new node of the given path and type
275 | ```python
276 | START
277 | 1. get parent_path and name from path
278 | 2. set new_pwd to cd(root, pwd, parent_path)
279 | 3. if (new_pwd is null)
280 | print parent_path does not exist
281 | return null
282 | end if
283 | 4. set node to find_on_pwd(new_pwd, name)
284 | 5. if (new_pwd is not null)
285 | print path already exists
286 | if (do not want to overwrite) return null
287 | remove(root, new_pwd, name)
288 | end if
289 | 6. set node to new TreeNode(new_pwd, name)
290 | 7. set node->type to type
291 | 8. set node->parent to new_pwd
292 | 9. set temp to new_pwd->child
293 | 10. if (temp is null)
294 | temp = node
295 | return node
296 | end if
297 | 11. loop (while temp->link is not null)
298 | temp = temp->link
299 | end loop
300 | 12. temp->link = node
301 | 13. return node
302 | STOP
303 | ```
304 | > Time Complexity = O(m*h)
305 | Auxiliary Space = O(1)
306 |
307 | ---
308 | ### remove(root, pwd, path)
309 | This algorithm removes the node of given path
310 | ```python
311 | START
312 | 1. set node to find_node(root, pwd, path)
313 | 2. if (node is null)
314 | print path does not exist
315 | return
316 | end if
317 | 3. if (node is not empty directory)
318 | print path is not empty
319 | if (not want to proceed) return
320 | end if
321 | 4. set temp to node->parent->child
322 | 5. if (temp is node)
323 | temp = node->link
324 | return
325 | end if
326 | 6. loop (while temp->link is not null)
327 | temp = temp->link
328 | 7. temp->link = node->link
329 | STOP
330 | ```
331 | > Time Complexity = O(m*h)
332 | Auxiliary Space = O(1)
333 |
334 | ---
335 | ### dupl(root, pwd, src_path, dst_path, keep)
336 | This algorithm copies or moves the node from src_path to dst_path
337 | ```python
338 | START
339 | 1. set src_node to find_node(root, pwd, src_path)
340 | 2. if (src_node is null)
341 | print src_path does not exist
342 | end if
343 | 3. store src_node data
344 | 4. set dst_node to find_node(root, pwd, dst_path)
345 | 5. if (dst_node is a directory)
346 | set dst_path to dst_path+"/"+src_name
347 | end if
348 | 6. set node to create(root, pwd, dst_path, src_node->type)
349 | 7. if (node is not null)
350 | set node data to src_node data
351 | else
352 | return
353 | 8. if (not keep)
354 | remove(root, pwd, src_path)
355 | end if
356 | STOP
357 | ```
358 | > Time Complexity = O(m*h)
359 | Auxiliary Space = O(1)
360 |
361 | ---
362 | ### cat(root, pwd, path)
363 | This algorithm displays the contents of the file in given path
364 | ```python
365 | START
366 | 1. set node to find_node(root, pwd, path)
367 | 2. if (node is null)
368 | print path does not exist
369 | return
370 | end if
371 | 3. if (node is not file)
372 | print path is not a file
373 | return
374 | end if
375 | 4. if (node does not have read permission)
376 | print path does not have read permission
377 | return
378 | end if
379 | 5. loop (for each line in node->content) print line
380 | STOP
381 | ```
382 | > Time Complexity = O(m*h)
383 | Auxiliary Space = O(1)
384 |
385 | ---
386 | ### edit(root, pwd, path)
387 | This algorithm change the contents of file in given path
388 | ```python
389 | START
390 | 1. set node to find_node(root, pwd, path)
391 | 2. if (node is null)
392 | if (create new file)
393 | set node to create(root, pwd, path, '-')
394 | else
395 | return
396 | end if
397 | end if
398 | 3. if (node is not a file)
399 | print path is not a file
400 | return
401 | end if
402 | 4. if (file is not empty)
403 | if (node does not have read permission)
404 | print path does not have read permission
405 | else
406 | print contents of file
407 | end if
408 | if (node does not have write permission)
409 | print path does not have write permission
410 | return
411 | end if
412 | if (not overwrite) return
413 | 5. clear node->content
414 | 6. read lines as string and push to node->content
415 | STOP
416 | ```
417 | > Time Complexity = O(m*h)
418 | Auxiliary Space = O(1)
419 |
420 | ---
421 | ### chmod(root, pwd, path, new_modes)
422 | This algorithm changes the permissions of the node
423 | ```python
424 | START
425 | 1. set node to find_node(root, pwd, path)
426 | 2. if (node is null)
427 | print path does not exist
428 | return
429 | end if
430 | 3. set prev_modes to node->perm_str
431 | 4. if (length of new_modes is 1 and new_modes is between '0' and '7')
432 | set node->perm to corresponding int value
433 | end if
434 | 5. loop (for each character in new_modes)
435 | if (character is valid permission and not in prev_modes)
436 | if (new_modes[0] is '+')
437 | update node->perm by adding those permissions
438 | else if (new_modes[0] is '-')
439 | update node->perm by removing those permissions
440 | end if
441 | else
442 | print permission string already exists or invalid
443 | end if
444 | end loop
445 | STOP
446 | ```
447 | > Time Complexity = O(m*h)
448 | Auxiliary Space = O(1)
449 |
450 | ---
451 |
452 | ## Dry Run
453 | File System before Dry Run,
454 | 
455 |
456 | ```bash
457 | cd /home/user
458 | ```
459 | 1. path_list = {"home", "user"}
460 | 2. node = root
461 | 3. looping path_list
462 | 1. node = find_on_pwd(node, "home")
463 | 2. node = find_on_pwd(node, "user")
464 | 4. return node
465 |
466 | ```bash
467 | ls
468 | ```
469 | 1. print "Desktop/"
470 | 2. print "Documents/"
471 | 3. print "Downloads/"
472 | 4. print "Pictures/"
473 | 5. print ".bashrc"
474 |
475 | ```bash
476 | touch prog1.c
477 | ```
478 | 1. parent_path = ""
479 | 2. new_pwd = pwd
480 | 3. node = find_on_pwd(new_pwd, "prog1.c")
481 | 4. node = new TreeNode(new_pwd, "prog1.c")
482 | 5. node->type = type
483 | 6. temp = new_pwd->child
484 | 7. when temp->link == NULL, temp->link = node
485 | 8. return node
--------------------------------------------------------------------------------
/main.cpp:
--------------------------------------------------------------------------------
1 | #include
2 | using namespace std;
3 |
4 | string time_now();
5 |
6 | class TreeNode{
7 | public:
8 | string name;
9 | list content;
10 | char type;
11 | string cdate;
12 | string mdate;
13 | int perm;
14 | TreeNode* link;
15 | TreeNode* parent;
16 | TreeNode* child;
17 |
18 | TreeNode(TreeNode* pwd, string n)
19 | {
20 | name = n;
21 | cdate = mdate = time_now();
22 | perm = 6;
23 | link = NULL;
24 | child = NULL;
25 | parent = pwd;
26 | }
27 |
28 | string get_perm()
29 | {
30 | string res;
31 | if (perm == 0) res = "---";
32 | else if (perm == 1) res = "--x";
33 | else if (perm == 2) res = "-w-";
34 | else if (perm == 3) res = "-wx";
35 | else if (perm == 4) res = "r--";
36 | else if (perm == 5) res = "r-x";
37 | else if (perm == 6) res = "rw-";
38 | else if (perm == 7) res = "rwx";
39 |
40 | return res;
41 | }
42 | };
43 |
44 | void linux_tree(TreeNode* root);
45 | void print_help();
46 | void print_tree(TreeNode* root, string prev);
47 | void print_ls(TreeNode* pwd);
48 | void print_stat(TreeNode* root, TreeNode* pwd, string path);
49 | string pwd_str(TreeNode* root, TreeNode* pwd);
50 | list find_names(TreeNode* root, TreeNode* pwd, string name);
51 | TreeNode* find_node(TreeNode* root, TreeNode* pwd, string path);
52 | TreeNode* find_on_pwd(TreeNode* pwd, string name);
53 | list split(string str, char delim);
54 | string join(list str, char delim);
55 | string* split_name(string str);
56 | TreeNode* cd(TreeNode* root, TreeNode* pwd, string path);
57 | TreeNode* create(TreeNode* root, TreeNode* pwd, string path, char type);
58 | void remove(TreeNode* root, TreeNode* pwd, string path);
59 | void dupl(TreeNode* root, TreeNode* pwd, string src, string dst, int keep);
60 | void edit(TreeNode* root, TreeNode* pwd, string path);
61 | void cat(TreeNode* root, TreeNode* pwd, string path);
62 | void chmod(TreeNode* root, TreeNode* pwd, string path, string new_modes);
63 |
64 | int main()
65 | {
66 | TreeNode* root = new TreeNode(NULL, "");
67 | root->type = 'd';
68 | TreeNode* pwd = root;
69 | linux_tree(root);
70 | print_help();
71 |
72 | string cmd;
73 | cout << endl << pwd_str(root, pwd) << ">> ";
74 | while (getline(cin >> ws, cmd))
75 | {
76 | list args = split(cmd, ' ');
77 | TreeNode* temp_pwd;
78 | if (cmd == "help")
79 | print_help();
80 | else if (args.front() == "ls")
81 | {
82 | if (args.size() == 1)
83 | print_ls(pwd->child);
84 | else while (args.size() != 1)
85 | {
86 | args.pop_front();
87 | cout << args.front() << ":" << endl;
88 | temp_pwd = cd(root, pwd, args.front());
89 | if (temp_pwd != NULL)
90 | print_ls(temp_pwd->child);
91 | }
92 | }
93 | else if (args.front() == "tree")
94 | {
95 | if (args.size() == 1)
96 | print_tree(pwd->child, "");
97 | else while (args.size() != 1)
98 | {
99 | args.pop_front();
100 | cout << args.front() << ":\n.\n";
101 | temp_pwd = cd(root, pwd, args.front());
102 | if (temp_pwd != NULL)
103 | print_tree(temp_pwd->child, "");
104 | }
105 |
106 | }
107 | else if (cmd == "pwd")
108 | cout << pwd_str(root, pwd) << endl;
109 | else if (args.front() == "cd")
110 | {
111 | if (args.size() == 1)
112 | pwd = root;
113 | else
114 | {
115 | args.pop_front();
116 | temp_pwd = cd(root, pwd, args.front());
117 | if (temp_pwd != NULL)
118 | pwd = temp_pwd;
119 | }
120 |
121 | }
122 | else if (args.front() == "find")
123 | {
124 | if (args.size() == 1)
125 | cout << "find: missing operand" << endl;
126 | else while(args.size() != 1)
127 | {
128 | args.pop_front();
129 | list res;
130 | if (args.front()[0] == '/')
131 | res = find_names(root, root, args.front());
132 | else
133 | res = find_names(pwd, pwd, args.front());
134 | if (res.size() == 0)
135 | cout << "find: '" << args.front() << "': no such file or directory" << endl;
136 | else
137 | for (list::iterator it = res.begin(); it != res.end(); it++)
138 | cout << *it << endl;
139 | }
140 | }
141 | else if (args.front() == "stat")
142 | {
143 | if (args.size() == 1)
144 | cout << "stat: missing operand" << endl;
145 | else while (args.size() != 1)
146 | {
147 | args.pop_front();
148 | print_stat(root, pwd, args.front());
149 | }
150 | }
151 | else if (args.front() == "mkdir")
152 | {
153 | if (args.size() == 1)
154 | cout << "mkdir: missing operand" << endl;
155 | else while(args.size() != 1)
156 | {
157 | args.pop_front();
158 | create(root, pwd, args.front(), 'd');
159 | }
160 | }
161 | else if (args.front() == "touch")
162 | {
163 | if (args.size() == 1)
164 | cout << "touch: missing operand" << endl;
165 | else while(args.size() != 1)
166 | {
167 | args.pop_front();
168 | create(root, pwd, args.front(), '-');
169 | }
170 | }
171 | else if (args.front() == "rm" || args.front() == "rmdir")
172 | {
173 | if (args.size() == 1)
174 | cout << args.front() << ": missing operand" << endl;
175 | else while(args.size() != 1)
176 | {
177 | args.pop_front();
178 | remove(root, pwd, args.front());
179 | }
180 | }
181 | else if (args.front() == "cp" || args.front() == "mv")
182 | {
183 | if (args.size() != 3)
184 | cout << args.front() << ": missing operand" << endl;
185 | else
186 | {
187 | int keep;
188 | if (args.front() == "cp") keep = 1;
189 | else keep = 0;
190 | args.pop_front();
191 | string src = args.front();
192 | args.pop_front();
193 | string dst = args.front();
194 | args.pop_front();
195 | dupl(root, pwd, src, dst, keep);
196 | }
197 | }
198 | else if (args.front() == "edit")
199 | {
200 | if (args.size() == 1)
201 | cout << "edit: missing operand" << endl;
202 | else
203 | {
204 | args.pop_front();
205 | edit(root, pwd, args.front());
206 | }
207 | }
208 | else if (args.front() == "cat")
209 | {
210 | if (args.size() == 1)
211 | cout << "cat: missing operand" << endl;
212 | else
213 | {
214 | args.pop_front();
215 | cat(root, pwd, args.front());
216 | }
217 | }
218 | else if (args.front() == "chmod")
219 | {
220 | if (args.size() < 3)
221 | cout << "chmod: missing operand" << endl;
222 | else
223 | {
224 | args.pop_front();
225 | string perm = args.front();
226 | args.pop_front();
227 | chmod(root, pwd, args.front(), perm);
228 | }
229 | }
230 | else if (cmd == "exit")
231 | return 0;
232 | else
233 | cout << "Unknown command" << endl;
234 |
235 | cout << endl << pwd_str(root, pwd) << ">> ";
236 | }
237 |
238 | cout << endl;
239 | return 0;
240 | }
241 |
242 | void print_help()
243 | {
244 | cout << "*** Follows the syntax of linux shell commands ***" << endl << endl;
245 | cout << "\thelp - print following message" << endl;
246 | cout << "\tls - list directory" << endl;
247 | cout << "\tcd - change directory" << endl;
248 | cout << "\ttree - display the files/directory in tree view" << endl;
249 | cout << "\tpwd - print working directory" << endl;
250 | cout << "\tfind - find file/directory path by name" << endl;
251 | cout << "\tstat - display file/directory information" << endl;
252 | cout << "\tcp - copy file" << endl;
253 | cout << "\tmv - move file" << endl;
254 | cout << "\tmkdir - make directory" << endl;
255 | cout << "\trmdir - remove directory" << endl;
256 | cout << "\ttouch - create file" << endl;
257 | cout << "\trm - remove file" << endl;
258 | cout << "\tcat - Display file content" << endl;
259 | cout << "\tedit - edit file" << endl;
260 | cout << "\tchmod - change file permission" << endl;
261 | cout << "\texit - exit program" << endl;
262 | }
263 |
264 | void print_tree(TreeNode* root, string prev)
265 | {
266 | if (root != NULL)
267 | {
268 | string next, branch, branch_next;
269 |
270 | if (root->link == NULL)
271 | {
272 | branch = "`";
273 | branch_next = " ";
274 | }
275 | else
276 | {
277 | branch = "|";
278 | branch_next = "|";
279 | }
280 | if (prev == "")
281 | {
282 | cout << prev + branch << "-- " << root->name;
283 | next = prev + branch_next;
284 | }
285 | else
286 | {
287 | cout << prev + " " + branch << "-- " << root->name;
288 | next = prev + " " + branch_next;
289 | }
290 |
291 | if (root->type == 'd')
292 | cout << "/";
293 | cout << endl;
294 |
295 | print_tree(root->child, next);
296 | print_tree(root->link, prev);
297 | }
298 | }
299 |
300 | void print_ls(TreeNode* pwd)
301 | {
302 | if (pwd != NULL)
303 | {
304 | cout << pwd->type << pwd->get_perm() << " " << pwd->mdate << " " << pwd->name;
305 | if (pwd->type == 'd') cout << "/";
306 | cout << endl;
307 |
308 | print_ls(pwd->link);
309 | }
310 | }
311 |
312 | void print_stat(TreeNode* root, TreeNode* pwd, string path)
313 | {
314 | TreeNode* node = find_node(root, pwd, path);
315 | cout << "File: " << node->name;
316 | if (node->type == 'd') cout << "/";
317 | cout << endl;
318 | cout << "Access: " << node->type << node->get_perm() << endl;
319 | cout << "Modified: " << node->mdate << endl;
320 | cout << "Created: " << node->cdate << endl;
321 | }
322 |
323 | string pwd_str(TreeNode* root, TreeNode* pwd)
324 | {
325 | string res = "";
326 | if (pwd == root)
327 | return "/";
328 | while (pwd != root)
329 | {
330 | res = "/" + pwd->name + res;
331 | pwd = pwd->parent;
332 | }
333 | return res;
334 | }
335 |
336 | list find_names(TreeNode* root, TreeNode* pwd, string name)
337 | {
338 | static list res;
339 | if (root == pwd)
340 | res.clear();
341 | if (pwd != NULL)
342 | {
343 | string path = pwd_str(root, pwd);
344 | if (path.find(name.c_str()) != string::npos)
345 | {
346 | res.push_back(path);
347 | }
348 | find_names(root, pwd->child, name);
349 | find_names(root, pwd->link, name);
350 | }
351 | return res;
352 | }
353 |
354 | TreeNode* find_node(TreeNode* root, TreeNode* pwd, string path)
355 | {
356 | string parent_path = split_name(path)[0];
357 | string name = split_name(path)[1];
358 | pwd = cd(root, pwd, parent_path);
359 | if (pwd == NULL)
360 | {
361 | return NULL;
362 | }
363 | return find_on_pwd(pwd, name);
364 | }
365 |
366 | TreeNode* find_on_pwd(TreeNode* pwd, string name)
367 | {
368 | pwd = pwd->child;
369 | while (pwd != NULL)
370 | {
371 | if (pwd->name == name)
372 | {
373 | return pwd;
374 | }
375 | pwd = pwd->link;
376 | }
377 | return NULL;
378 | }
379 |
380 | list split(string str, char delim)
381 | {
382 | list res;
383 | string temp = "";
384 | for (int i = 0; i < (int)str.size(); i++)
385 | {
386 | if (str[i] != delim)
387 | temp += str[i];
388 | else
389 | {
390 | res.push_back(temp);
391 | temp = "";
392 | }
393 | }
394 | if (temp != "")
395 | res.push_back(temp);
396 | return res;
397 | }
398 |
399 | string join(list str, char delim)
400 | {
401 | string res = "";
402 | for (list::iterator it = str.begin(); it != str.end(); ++it)
403 | {
404 | res += *it;
405 | if (it != --str.end())
406 | res += delim;
407 | }
408 | return res;
409 | }
410 |
411 | string* split_name(string str)
412 | {
413 | string* res = new string[2];
414 |
415 | list temp = split(str, '/');
416 | res[1] = temp.back();
417 | temp.pop_back();
418 | res[0] = join(temp, '/');
419 |
420 | return res;
421 | }
422 |
423 | TreeNode* cd(TreeNode* root, TreeNode* pwd, string path)
424 | {
425 | list path_list = split(path, '/');
426 | list::iterator it = path_list.begin();
427 | TreeNode* temp;
428 |
429 | if (path[0] == '/')
430 | {
431 | temp = root;
432 | it++;
433 | }
434 | else if (path_list.front() == ".")
435 | {
436 | if (path_list.size() == 1)
437 | return pwd;
438 | else
439 | {
440 | temp = pwd;
441 | it++;
442 | }
443 | }
444 | else if (path_list.front() == "..")
445 | {
446 | if (path_list.size() == 1)
447 | return pwd->parent;
448 | else
449 | {
450 | temp = pwd->parent;
451 | it++;
452 | }
453 | }
454 | else
455 | {
456 | temp = pwd;
457 | }
458 |
459 | for (; it != path_list.end(); it++)
460 | {
461 | temp = find_on_pwd(temp, *it);
462 | if (temp == NULL || temp->type != 'd')
463 | {
464 | cout << "the directory '" << path << "' does not exist" << endl;
465 | return NULL;
466 | }
467 | }
468 | return temp;
469 | }
470 |
471 | TreeNode* create(TreeNode* root, TreeNode* pwd, string path, char type)
472 | {
473 | string parent_path = split_name(path)[0];
474 | string name = split_name(path)[1];
475 |
476 | TreeNode* new_pwd = cd(root, pwd, parent_path);
477 | if (new_pwd == NULL)
478 | {
479 | cout << "the directory '" << parent_path << "' does not exist" << endl;
480 | return NULL;
481 | }
482 |
483 | TreeNode* temp = find_on_pwd(new_pwd, name);
484 | string choice = "";
485 | if (temp != NULL)
486 | {
487 | cout << "the file or directory '" << path << "' already exists" << endl;
488 | cout << "overwrite? (y/n) ";
489 | cin >> choice;
490 | if (choice != "y" && choice != "Y" && choice != "yes" && choice != "Yes")
491 | return NULL;
492 | remove(root, new_pwd, name);
493 | }
494 |
495 | temp = new TreeNode(new_pwd, name);
496 | temp->type = type;
497 | temp->parent = new_pwd;
498 |
499 | if (new_pwd->child == NULL)
500 | {
501 | new_pwd->child = temp;
502 | return temp;
503 | }
504 | TreeNode* prev = new_pwd->child;
505 | while (prev->link != NULL)
506 | prev = prev->link;
507 | prev->link = temp;
508 |
509 | return temp;
510 | }
511 |
512 | void remove(TreeNode* root, TreeNode* pwd, string path)
513 | {
514 | TreeNode* temp = find_node(root, pwd, path);
515 | if (temp == NULL)
516 | {
517 | cout << "the file or directory '" << path << "' does not exist" << endl;
518 | return;
519 | }
520 | string choice = "";
521 | if (temp->type == 'd' && temp->child != NULL)
522 | {
523 | cout << "the directory '" << path << "' is not empty" << endl;
524 | cout << "proceed? (y/n) ";
525 | cin >> choice;
526 | if (choice != "y" && choice != "Y" && choice != "yes" && choice != "Yes")
527 | return;
528 | }
529 |
530 | if (temp->parent->child == temp)
531 | {
532 | temp->parent->child = temp->link;
533 | return;
534 | }
535 | TreeNode* prev = temp->parent->child;
536 | while (prev->link != temp)
537 | prev = prev->link;
538 | prev->link = temp->link;
539 | }
540 |
541 | void dupl(TreeNode* root, TreeNode* pwd, string src, string dst, int keep)
542 | {
543 | TreeNode* src_node = find_node(root, pwd, src);
544 | if (src_node == NULL)
545 | {
546 | cout << "the file or directory '" << src << "' does not exist" << endl;
547 | return;
548 | }
549 | string src_cdate = src_node->cdate;
550 | int src_perm = src_node->perm;
551 | list src_content = src_node->content;
552 |
553 | TreeNode* dst_node = find_node(root, pwd, dst);
554 | if (dst_node != NULL && dst_node->type == 'd')
555 | {
556 | dst += "/" + src_node->name;
557 | }
558 |
559 | TreeNode* new_node = create(root, pwd, dst, src_node->type);
560 | if (new_node != NULL)
561 | {
562 | new_node->cdate = src_cdate;
563 | new_node->perm = src_perm;
564 | new_node->content = src_content;
565 | }
566 | else
567 | return;
568 |
569 | if (keep == 0)
570 | {
571 | remove(root, pwd, src);
572 | }
573 |
574 | return;
575 | }
576 |
577 | void cat(TreeNode* root, TreeNode* pwd, string path)
578 | {
579 | TreeNode* temp = find_node(root, pwd, path);
580 | if (temp == NULL)
581 | {
582 | cout << "the file '" << path << "' does not exist" << endl;
583 | return;
584 | }
585 | if (temp->type != '-')
586 | {
587 | cout << "'" << path << "' is not a file" << endl;
588 | return;
589 | }
590 | if (temp->perm < 4)
591 | {
592 | cout << "you don't have permission to read '" << path << "'" << endl;
593 | return;
594 | }
595 | for (list::iterator it = temp->content.begin(); it != temp->content.end(); it++)
596 | cout << *it << endl;
597 | }
598 |
599 | void edit(TreeNode* root, TreeNode* pwd, string path)
600 | {
601 | TreeNode* temp = find_node(root, pwd, path);
602 | if (temp == NULL)
603 | {
604 | cout << "the file '" << path << "' does not exist" << endl;
605 | string choice = "";
606 | cout << "create it? (y/n) ";
607 | cin >> choice;
608 | if (choice != "y" && choice != "Y" && choice != "yes" && choice != "Yes")
609 | return;
610 | temp = create(root, pwd, path, '-');
611 | }
612 | if (temp->type != '-')
613 | {
614 | cout << "'" << path << "' is not a file" << endl;
615 | return;
616 | }
617 |
618 | if (!temp->content.empty())
619 | {
620 | if (temp->perm < 4)
621 | {
622 | cout << "you don't have permission to read '" << path << "'" << endl;
623 | }
624 | else
625 | {
626 | list old_content = temp->content;
627 | cout << "content: " << endl;
628 | for (list::iterator it = old_content.begin(); it != old_content.end(); it++)
629 | cout << *it << endl;
630 | }
631 |
632 | if (temp->perm < 2 || temp->perm == 4 || temp->perm == 5)
633 | {
634 | cout << "you don't have permission to write '" << path << "'" << endl;
635 | return;
636 | }
637 |
638 | string choice = "";
639 | cout << endl << "overwrite? (y/n) ";
640 | cin >> choice;
641 | if (choice != "y" && choice != "Y" && choice != "yes" && choice != "Yes")
642 | return;
643 | }
644 |
645 | temp->content.clear();
646 | cout << endl << temp->name << " : (enter \\n to save)" << endl;
647 | string line;
648 | while (1)
649 | {
650 | getline(cin, line);
651 | if (line == "\\n")
652 | break;
653 | temp->content.push_back(line);
654 | }
655 | }
656 |
657 | void chmod(TreeNode* root, TreeNode* pwd, string path, string new_modes)
658 | {
659 | TreeNode* temp = find_node(root, pwd, path);
660 | if (temp == NULL)
661 | {
662 | cout << "the file or directory '" << path << "' does not exist" << endl;
663 | return;
664 | }
665 |
666 | string perm_str = temp->get_perm();
667 | if (new_modes[0] == '+')
668 | {
669 | for (int i = 1; i < new_modes.size(); i++)
670 | {
671 | if (new_modes[i] == 'r' && perm_str.find('r') == string::npos)
672 | temp->perm += 4;
673 | else if (new_modes[i] == 'w' && perm_str.find('w') == string::npos)
674 | temp->perm += 2;
675 | else if (new_modes[i] == 'x' && perm_str.find('x') == string::npos)
676 | temp->perm += 1;
677 | else
678 | cout << "chmod: permission '" << new_modes[i] << "' already present or invalid\n";
679 | }
680 | }
681 | else if (new_modes[0] == '-')
682 | {
683 | for (int i = 1; i < new_modes.size(); i++)
684 | {
685 | if (new_modes[i] == 'r' && perm_str.find('r') != string::npos)
686 | temp->perm -= 4;
687 | else if (new_modes[i] == 'w' && perm_str.find('w') != string::npos)
688 | temp->perm -= 2;
689 | else if (new_modes[i] == 'x' && perm_str.find('x') != string::npos)
690 | temp->perm -= 1;
691 | else
692 | cout << "chmod: permission '" << new_modes[i] << "' already present or invalid\n";
693 | }
694 | }
695 | else if (new_modes.size() == 1 && new_modes[0] >= 48 && new_modes[0] <= 55)
696 | {
697 | temp->perm = new_modes[0]-48;
698 | }
699 | else
700 | {
701 | cout << "chmod: invalid permissions '" << new_modes << "'\n";
702 | }
703 |
704 | }
705 |
706 | string time_now()
707 | {
708 | string res = "", temp;
709 | time_t now = time(0);
710 | tm *ltm = localtime(&now);
711 |
712 | res += to_string(ltm->tm_mday) + " ";
713 |
714 | int month = ltm->tm_mon + 1;
715 | if (month == 1) res += "Jan ";
716 | else if (month == 2) res += "Feb ";
717 | else if (month == 3) res += "Mar ";
718 | else if (month == 4) res += "Apr ";
719 | else if (month == 5) res += "May ";
720 | else if (month == 6) res += "Jun ";
721 | else if (month == 7) res += "Jul ";
722 | else if (month == 8) res += "Aug ";
723 | else if (month == 9) res += "Sep ";
724 | else if (month == 10) res += "Oct ";
725 | else if (month == 11) res += "Nov ";
726 | else if (month == 12) res += "Dec ";
727 |
728 | if (to_string(ltm->tm_hour).size() == 1) res += "0";
729 | res += to_string(ltm->tm_hour) + ":";
730 | if (to_string(ltm->tm_min).size() == 1) res += "0";
731 | res += to_string(ltm->tm_min);
732 |
733 | return res;
734 | }
735 |
736 | void linux_tree(TreeNode* root)
737 | {
738 | vector Dirs{"bin", "etc", "etc/systemd", "etc/systemd/system", "etc/systemd/user",
739 | "home", "home/user", "home/user/Desktop", "home/user/Documents", "home/user/Downloads",
740 | "home/user/Pictures", "tmp"};
741 | vector Files{"bin/bash", "bin/cd", "bin/gcc", "bin/ls", "bin/python",
742 | "etc/systemd/system/display-manager.service", "etc/systemd/system.conf", "etc/systemd/user.conf",
743 | "etc/hosts", "etc/passwd", "etc/profile", "home/user/.bashrc"};
744 |
745 | for (string d : Dirs)
746 | {
747 | create(root, root, d, 'd');
748 | }
749 | for (string f : Files)
750 | {
751 | create(root, root, f, '-');
752 | }
753 | }
--------------------------------------------------------------------------------
/media/image1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/abhishekmj303/FileSystem-Emulator/6adf12b73f5f3061e6bd1242bf0716caae17e6a9/media/image1.png
--------------------------------------------------------------------------------
/media/image2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/abhishekmj303/FileSystem-Emulator/6adf12b73f5f3061e6bd1242bf0716caae17e6a9/media/image2.png
--------------------------------------------------------------------------------
/media/image3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/abhishekmj303/FileSystem-Emulator/6adf12b73f5f3061e6bd1242bf0716caae17e6a9/media/image3.png
--------------------------------------------------------------------------------