├── .gitignore
├── .merlin
├── LICENSE
├── Makefile
├── README.md
├── _oasis
├── configure
├── opam
├── setup.ml
├── src
├── lexdep.mll
├── main.ml
├── merlin.ml
├── metafile.ml
├── oasis.ml
├── opam.ml
├── parsedep.mly
└── userInput.ml
├── templates
├── .merlin
├── _oasis
└── opam
└── test
├── .merlin
├── .ogen
├── _oasis
├── opam
└── src
└── main.ml
/.gitignore:
--------------------------------------------------------------------------------
1 | *.annot
2 | *.cmo
3 | *.cma
4 | *.cmi
5 | *.a
6 | *.o
7 | *.cmx
8 | *.cmxs
9 | *.cmxa
10 | *.token
11 |
12 | # ocamlbuild working directory
13 | _build/
14 |
15 | # ocamlbuild targets
16 | *.byte
17 | *.native
18 |
19 | # oasis generated files
20 | setup.data
21 | setup.log
22 |
--------------------------------------------------------------------------------
/.merlin:
--------------------------------------------------------------------------------
1 | S src
2 | B _build/src
3 | PKG batteries linenoise inifiles ppx_deriving_yojson ppx_blob
4 |
--------------------------------------------------------------------------------
/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 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
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 | {project} Copyright (C) {year} {fullname}
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 | # OASIS_START
2 | # DO NOT EDIT (digest: a3c674b4239234cbbe53afe090018954)
3 |
4 | SETUP = ocaml setup.ml
5 |
6 | build: setup.data
7 | $(SETUP) -build $(BUILDFLAGS)
8 |
9 | doc: setup.data build
10 | $(SETUP) -doc $(DOCFLAGS)
11 |
12 | test: setup.data build
13 | $(SETUP) -test $(TESTFLAGS)
14 |
15 | all:
16 | $(SETUP) -all $(ALLFLAGS)
17 |
18 | install: setup.data
19 | $(SETUP) -install $(INSTALLFLAGS)
20 |
21 | uninstall: setup.data
22 | $(SETUP) -uninstall $(UNINSTALLFLAGS)
23 |
24 | reinstall: setup.data
25 | $(SETUP) -reinstall $(REINSTALLFLAGS)
26 |
27 | clean:
28 | $(SETUP) -clean $(CLEANFLAGS)
29 |
30 | distclean:
31 | $(SETUP) -distclean $(DISTCLEANFLAGS)
32 |
33 | setup.data:
34 | $(SETUP) -configure $(CONFIGUREFLAGS)
35 |
36 | configure:
37 | $(SETUP) -configure $(CONFIGUREFLAGS)
38 |
39 | .PHONY: build doc test all install uninstall reinstall clean distclean configure
40 |
41 | # OASIS_STOP
42 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ogen
2 | A tool for creating new OCaml projects with OPAM, Oasis, and Merlin
3 |
4 | ## Installation
5 |
6 | If you have `opam` installed and are on OCaml version 4.02 or higher, you can simply run `opam install ogen`.
7 |
8 | ## Usage
9 |
10 | ### Creating a project
11 |
12 | The basic usage is `ogen [-nopam] [-noasis] [project name]`.
13 |
14 | The `-noasis` flag disables the `_oasis` generator and the `-nopam` flag disables generating OPAM packaging files.
15 |
16 | ```bash
17 | $ ogen
18 | Package name? [default: ] MyProject
19 | Package version? [default: 1.0.0] 1.0
20 | Please choose a license: [default: All Rights Reserved] GPL
21 | Author name? [default: ]
22 | Author email? [default: ]
23 | Project homepage URL? https://github.com//
24 | Project synopsis?
25 | What does the package build? [Library/Executable] l
26 | ```
27 |
28 | ### Updating the project
29 |
30 | To regenerate the files from the `.ogen` file, you can run `ogen -refresh`.
31 |
32 | *WARNING: This will clear out changes to your current _oasis, opam, and .merlin files*
33 |
34 | ### Adding dependencies
35 |
36 | If you want to add a new dependency, you can do so using the following syntax: `ogen -depend `,
37 | where `` matches the following format:
38 |
39 | ```
40 | name ::= any string
41 |
42 | version ::= any string
43 |
44 | constraint ::= "{" constraints "}"
45 |
46 | op ::= "=" | "!=" | "<" | ">" | "<=" | ">="
47 |
48 | constraints ::= op "[" version "]"
49 | | "!" constraints
50 | | constraints "&" constraints
51 | | constraints "|" constraints
52 |
53 | dependency ::= name constraint?
54 | ```
55 |
56 | Because of limitations of shells, you'll need to quote the dependency if you're using any constraints.
57 |
58 | ## Planned features
59 |
60 | * Human-editable global config file?
61 | + Could be TOML, INI, JSON, YAML. Preferably not a custom format
62 | + Replace .opamcreate
63 | + Inject code into OASIS' Makefile to refresh?
64 |
65 | * `ogen -tests` - Generate a test section in your `_oasis` file and create the directory
66 |
--------------------------------------------------------------------------------
/_oasis:
--------------------------------------------------------------------------------
1 | Name: ogen
2 | Version: 0.1.3
3 | Synopsis: A tool for creating new OCaml projects with OPAM, Oasis, and Merlin
4 | Authors: nv-vn
5 | License: GPL
6 |
7 | OASISFormat: 0.4
8 | BuildTools: ocamlbuild
9 | Plugins: META (0.4), DevFiles (0.4)
10 |
11 | Executable "ogen"
12 | Path: src/
13 | MainIs: main.ml
14 | CompiledObject: best
15 | BuildDepends: batteries, linenoise, inifiles, yojson, ppx_deriving, ppx_deriving_yojson, ppx_blob
16 | BuildTools: ocamllex, ocamlyacc
17 |
--------------------------------------------------------------------------------
/configure:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | # OASIS_START
4 | # DO NOT EDIT (digest: dc86c2ad450f91ca10c931b6045d0499)
5 | set -e
6 |
7 | FST=true
8 | for i in "$@"; do
9 | if $FST; then
10 | set --
11 | FST=false
12 | fi
13 |
14 | case $i in
15 | --*=*)
16 | ARG=${i%%=*}
17 | VAL=${i##*=}
18 | set -- "$@" "$ARG" "$VAL"
19 | ;;
20 | *)
21 | set -- "$@" "$i"
22 | ;;
23 | esac
24 | done
25 |
26 | ocaml setup.ml -configure "$@"
27 | # OASIS_STOP
28 |
--------------------------------------------------------------------------------
/opam:
--------------------------------------------------------------------------------
1 | opam-version: "1.2"
2 | maintainer: "nv-vn "
3 | authors: "nv-vn "
4 | homepage: "https://github.com/nv-vn/ogen"
5 | bug-reports: "https://github.com/nv-vn/ogen/issues"
6 | license: "GPL"
7 | dev-repo: "https://github.com/nv-vn/ogen.git"
8 | build: [
9 | ["./configure" "--prefix=%{prefix}%"]
10 | [make]
11 | ]
12 | install: ["cp" "./main.native" "%{bin}%/ogen"]
13 | remove: ["rm" "%{bin}%/ogen"]
14 | available: [
15 | ocaml-version >= "4.02"
16 | ]
17 | depends: [
18 | "ocamlfind" {build}
19 | "oasis" {build}
20 | "batteries" {>= "2.0.0" & < "3.0.0"}
21 | "linenoise" {>= "0.9.0" & < "1.0.0"}
22 | "ocaml-inifiles" {>= "1.2" & < "2.0"}
23 | "yojson" {>= "1.3.0" & < "2.0.0"}
24 | "ppx_blob" {>= "0.1"}
25 | "ppx_deriving" {>= "4.0"}
26 | "ppx_deriving_yojson" {>= "3.0"}
27 | ]
--------------------------------------------------------------------------------
/setup.ml:
--------------------------------------------------------------------------------
1 | (* setup.ml generated for the first time by OASIS v0.4.5 *)
2 |
3 | (* OASIS_START *)
4 | (* DO NOT EDIT (digest: 9852805d5c19ca1cb6abefde2dcea323) *)
5 | (******************************************************************************)
6 | (* OASIS: architecture for building OCaml libraries and applications *)
7 | (* *)
8 | (* Copyright (C) 2011-2013, Sylvain Le Gall *)
9 | (* Copyright (C) 2008-2011, OCamlCore SARL *)
10 | (* *)
11 | (* This library is free software; you can redistribute it and/or modify it *)
12 | (* under the terms of the GNU Lesser General Public License as published by *)
13 | (* the Free Software Foundation; either version 2.1 of the License, or (at *)
14 | (* your option) any later version, with the OCaml static compilation *)
15 | (* exception. *)
16 | (* *)
17 | (* This library is distributed in the hope that it will be useful, but *)
18 | (* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *)
19 | (* or FITNESS FOR A PARTICULAR PURPOSE. See the file COPYING for more *)
20 | (* details. *)
21 | (* *)
22 | (* You should have received a copy of the GNU Lesser General Public License *)
23 | (* along with this library; if not, write to the Free Software Foundation, *)
24 | (* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *)
25 | (******************************************************************************)
26 |
27 | let () =
28 | try
29 | Topdirs.dir_directory (Sys.getenv "OCAML_TOPLEVEL_PATH")
30 | with Not_found -> ()
31 | ;;
32 | #use "topfind";;
33 | #require "oasis.dynrun";;
34 | open OASISDynRun;;
35 |
36 | (* OASIS_STOP *)
37 | let () = setup ();;
38 |
--------------------------------------------------------------------------------
/src/lexdep.mll:
--------------------------------------------------------------------------------
1 | {
2 | open Parsedep
3 | exception Eof
4 | }
5 |
6 | rule token = parse
7 | | [' ' '\t' '\n' '\r']
8 | { token lexbuf }
9 | | ['a'-'z' 'A'-'Z' '0'-'9' '-' '_' '.']+ as name
10 | { NAME name }
11 | | '['
12 | { string "" false lexbuf }
13 | | '{'
14 | { LBRACE }
15 | | '}'
16 | { RBRACE }
17 | | '!'
18 | { NOT }
19 | | '&'
20 | { AND }
21 | | '|'
22 | { OR }
23 | | '='
24 | { EQ }
25 | | '>'
26 | { GREATER }
27 | | '<'
28 | { LESS }
29 | | eof
30 | { EOF }
31 |
32 | and string acc escaped = parse
33 | | '\\'
34 | { string acc true lexbuf }
35 | | ']'
36 | { if not escaped then VERSION acc
37 | else string (acc ^ "\"") escaped lexbuf }
38 | | _ as ch
39 | { if not escaped then string (acc ^ (String.make 1 ch)) escaped lexbuf
40 | else string (acc ^ "\\" ^ (String.make 1 ch)) escaped lexbuf }
41 |
--------------------------------------------------------------------------------
/src/main.ml:
--------------------------------------------------------------------------------
1 | open Batteries
2 |
3 | let () =
4 | let usage = "ogen [-noasis] [-nopam] [name]" in
5 | let oasis = ref true
6 | and opam = ref true
7 | and name = ref None
8 | and mode = ref `Gen in
9 | Arg.parse [
10 | "-noasis", Arg.Clear oasis, "Don't output OASIS file";
11 | "-nopam", Arg.Clear opam, "Don't output OPAM repo files";
12 | "-depend", Arg.Rest (fun s -> mode := `Depend s), "Add a dependency";
13 | "-refresh", Arg.Unit (fun _ -> mode := `Refresh), "Regenerate all files";
14 | "-main", Arg.String (fun s -> mode := `Main s), "Set the main module for compilation";
15 | "-modules", Arg.Rest (fun s -> match !mode with `Modules t -> mode := `Modules (s ^ " " ^ t) | _ -> mode := `Modules s), "Add modules to export";
16 | "-tests", Arg.Unit (fun _ -> mode := `Test), "Generate tests for the repository"
17 | ] (fun n -> name := Some n) usage;
18 | match !mode with
19 | | `Gen -> begin
20 | match UserInput.create !oasis !opam !name with
21 | | None -> ()
22 | | Some meta ->
23 | Merlin.generic_fill ".merlin" meta;
24 | if !oasis then Oasis.generic_fill "_oasis" meta;
25 | if !opam then Opam.generic_fill "opam" meta (* Maybe emit to sub-dir? *)
26 | end
27 | | `Refresh -> begin
28 | match Metafile.load_meta () with
29 | | Ok meta ->
30 | Merlin.generic_fill ".merlin" meta;
31 | if !oasis then Oasis.generic_fill "_oasis" meta;
32 | if !opam then Opam.generic_fill "opam" meta
33 | | Error _ -> print_endline "Error: Generate a project before running `ogen -refresh`"
34 | end
35 | | `Depend dependency -> begin
36 | match Metafile.load_meta () with
37 | | Ok meta ->
38 | let lexbuf = Lexing.from_string dependency in
39 | let dep = Parsedep.main Lexdep.token lexbuf in
40 | let meta' = Metafile.{meta with dependencies = dep::meta.dependencies} in
41 | Metafile.save_meta meta';
42 | Merlin.generic_fill ".merlin" meta';
43 | if !oasis then Oasis.generic_fill "_oasis" meta';
44 | if !opam then Opam.generic_fill "opam" meta'
45 | | Error _ -> print_endline "Error: Generate a project before running `ogen -depend`"
46 | end
47 | | `Main main -> begin
48 | match Metafile.load_meta () with
49 | | Ok ({Metafile.package_type = `Exe _} as meta) ->
50 | let meta' = Metafile.{meta with package_type = `Exe main} in
51 | Metafile.save_meta meta';
52 | Merlin.generic_fill ".merlin" meta';
53 | Oasis.generic_fill "_oasis" meta';
54 | Opam.generic_fill "opam" meta';
55 | if Sys.file_exists ("src/" ^ main) then ()
56 | else if Sys.file_exists "src/" then
57 | File.with_file_out ("src/" ^ main)
58 | (fun handle -> Printf.fprintf handle "let () = ()")
59 | else begin
60 | Unix.mkdir "src/" 0o744;
61 | File.with_file_out ("src/" ^ main)
62 | (fun handle -> Printf.fprintf handle "let () = ()")
63 | end
64 | | Ok {Metafile.package_type = `Lib _} -> print_endline "Error: Only executables can contain a main file"
65 | | Error _ -> print_endline "Error: Generate a project before running `ogen -main`"
66 | end
67 | | `Modules modules -> begin
68 | match Metafile.load_meta () with
69 | | Ok ({Metafile.package_type = `Lib old_modules} as meta) ->
70 | let modules' = String.nsplit ~by:" " modules in
71 | let meta' = Metafile.{meta with package_type = `Lib (List.append old_modules modules' |> List.unique)} in
72 | Metafile.save_meta meta';
73 | Merlin.generic_fill ".merlin" meta';
74 | if !oasis then Oasis.generic_fill "_oasis" meta';
75 | if !opam then Opam.generic_fill "opam" meta';
76 | if not (Sys.file_exists "src/") then
77 | Unix.mkdir "src/" 0o744
78 | else ();
79 | let create_module module_ =
80 | let file = String.uncapitalize module_ ^ ".ml" in
81 | if Sys.file_exists ("src/" ^ file) then ()
82 | else File.with_file_out ("src/" ^ file)
83 | (fun handle -> Printf.fprintf handle "let () = ()") in
84 | List.iter create_module modules'
85 | | Ok {Metafile.package_type = `Exe _} -> print_endline "Error: Only libraries can contain modules"
86 | | Error _ -> print_endline "Error: Generate a project before running `ogen -modules`"
87 | end
88 | | _ -> print_endline "Not yet implemented!"
89 |
--------------------------------------------------------------------------------
/src/merlin.ml:
--------------------------------------------------------------------------------
1 | open Metafile
2 | open Batteries
3 |
4 | let template : (string -> string -> string -> string -> string -> unit,
5 | unit BatInnerIO.output, unit) Printf.t = [%blob "../templates/.merlin"]
6 |
7 | let fill_template ~filename ~sourcedir ~buildir ~packages ~extensions ~flags =
8 | File.with_file_out filename
9 | (fun handle ->
10 | Printf.fprintf handle template sourcedir buildir packages extensions flags)
11 |
12 | let generic_fill filename {dependencies} =
13 | let packages = List.map (fun x -> x.package_name) dependencies |> String.concat " " in
14 | fill_template ~filename ~sourcedir:"src/" ~buildir:"_build/src/" ~packages ~extensions:"" ~flags:""
15 |
--------------------------------------------------------------------------------
/src/metafile.ml:
--------------------------------------------------------------------------------
1 | type author = {
2 | username : string;
3 | email : string
4 | } [@@deriving yojson]
5 |
6 | type constraints =
7 | | Not of constraints
8 | | And of constraints * constraints
9 | | Or of constraints * constraints
10 | | Eq of string
11 | | NEq of string
12 | | Less of string
13 | | Greater of string
14 | | LEq of string
15 | | GEq of string
16 | [@@deriving yojson]
17 |
18 | type package = {
19 | package_name : string;
20 | constraints : constraints option
21 | } [@@deriving yojson]
22 |
23 | type meta = {
24 | name : string;
25 | version : string;
26 | license : string;
27 | author : author;
28 | homepage : string option;
29 | synopsis : string;
30 | package_type : [`Exe of string | `Lib of string list];
31 | dependencies : package list
32 | } [@@deriving yojson]
33 |
34 | let save_meta ?(filename=".ogen") meta =
35 | open_out filename |> fun handle -> begin
36 | meta_to_yojson meta |> Yojson.Safe.pretty_to_channel handle;
37 | close_out handle
38 | end
39 |
40 | let load_meta ?(filename=".ogen") () =
41 | Yojson.Safe.from_file filename |> meta_of_yojson
42 |
--------------------------------------------------------------------------------
/src/oasis.ml:
--------------------------------------------------------------------------------
1 | open Metafile
2 | open Batteries
3 |
4 | let template : (string -> string -> string -> string -> string -> string -> string -> string -> string -> string -> string -> unit,
5 | unit BatInnerIO.output, unit) Printf.t = [%blob "../templates/_oasis"]
6 |
7 | let fill_template ~filename ~name ~version ~synopsis ~author_name ~author_email ~license ~package_type ~sourcedir ~dependencies =
8 | let build_type, files = match package_type with
9 | | `Exe main -> ("Executable", "MainIs: " ^ main)
10 | | `Lib modules -> ("Library", "Modules: " ^ String.concat ", " modules) in
11 | File.with_file_out filename
12 | (fun handle ->
13 | Printf.fprintf handle template name version synopsis author_name author_email license build_type name sourcedir files dependencies)
14 |
15 | let generic_fill filename {name; version; synopsis; author; license; package_type; dependencies} =
16 | let packages = List.map (fun x -> x.package_name) dependencies |> String.concat ", " in
17 | fill_template ~filename ~name ~version ~synopsis ~author_name:author.username ~author_email:author.email ~license ~package_type
18 | ~sourcedir:"src/" ~dependencies:packages
19 |
--------------------------------------------------------------------------------
/src/opam.ml:
--------------------------------------------------------------------------------
1 | open Metafile
2 | open Batteries
3 |
4 | let template : (string -> string -> string -> string -> string -> string -> string -> string -> string -> string -> unit,
5 | unit BatInnerIO.output, unit) Printf.t = [%blob "../templates/opam"]
6 |
7 | let fill_template ~filename ~author_name ~author_email ~homepage ~license ~name ~dependencies =
8 | let bug_reports = homepage ^ "/issues" (* Specific to Github/Gitlab/Bitbucket *)
9 | and dev_repo = homepage ^ ".git" in (* Specific to Git in general *)
10 | File.with_file_out filename
11 | (fun handle ->
12 | Printf.fprintf handle template author_name author_email author_name author_email homepage bug_reports license dev_repo name dependencies)
13 |
14 | let generic_fill filename {author = {username; email}; homepage; license; name; dependencies} =
15 | let expand_package {package_name; constraints} =
16 | let rec format_constraint = function
17 | | Not c -> "!" ^ format_constraint c
18 | | And (a, b) -> format_constraint a ^ " & " ^ format_constraint b
19 | | Or (a, b) -> format_constraint a ^ " | " ^ format_constraint b
20 | | Eq v -> "= \"" ^ v ^ "\""
21 | | NEq v -> "!= \"" ^ v ^ "\""
22 | | Less v -> "< \"" ^ v ^ "\""
23 | | Greater v -> "> \"" ^ v ^ "\""
24 | | LEq v -> "<= \"" ^ v ^ "\""
25 | | GEq v -> ">= \"" ^ v ^ "\"" in
26 | let string_of_constraint c = " {" ^ format_constraint c ^ "}" in
27 | (* Tabulate 2 spaces for all of these *)
28 | match Option.map string_of_constraint constraints with
29 | | Some c -> " \"" ^ package_name ^ "\"" ^ c
30 | | None -> " \"" ^ package_name ^ "\"" in
31 | let packages = List.map expand_package dependencies |> String.concat "\n"
32 | and homepage = match homepage with Some h -> h | None -> "" in
33 | fill_template ~filename ~author_name:username ~author_email:email ~homepage ~license ~name ~dependencies:packages
34 |
--------------------------------------------------------------------------------
/src/parsedep.mly:
--------------------------------------------------------------------------------
1 | %{
2 | open Metafile
3 | %}
4 |
5 | %token EOF
6 | %token LBRACE RBRACE
7 | %token NOT AND OR EQ GREATER LESS
8 | %token NAME
9 | %token VERSION
10 |
11 | %start main
12 | %type main
13 |
14 | %%
15 |
16 | main:
17 | | NAME EOF
18 | { {package_name = $1; constraints = None} }
19 | | NAME LBRACE constraints RBRACE EOF
20 | { {package_name = $1; constraints = Some $3} }
21 | ;
22 |
23 | constraints:
24 | | NOT constraints
25 | { Not $2 }
26 | | constraints AND constraints
27 | { And ($1, $3) }
28 | | constraints OR constraints
29 | { Or ($1, $3) }
30 | | EQ VERSION
31 | { Eq $2 }
32 | | NOT EQ VERSION
33 | { NEq $3 }
34 | | LESS VERSION
35 | { Less $2 }
36 | | GREATER VERSION
37 | { Greater $2 }
38 | | LESS EQ VERSION
39 | { LEq $3 }
40 | | GREATER EQ VERSION
41 | { GEq $3 }
42 | ;
43 |
--------------------------------------------------------------------------------
/src/userInput.ml:
--------------------------------------------------------------------------------
1 | open Batteries
2 | open Batteries.Option
3 | open Batteries.Option.Infix
4 |
5 | let prompt_or_empty prompt =
6 | LNoise.linenoise prompt >>= function "" -> None | s -> Some s
7 |
8 | let prompt_default prompt default_option =
9 | let prompt' = prompt ^ " [default: " ^ default_option ^ "] " in
10 | let input = LNoise.linenoise prompt' >>= function "" -> None | s -> Some s in
11 | default default_option input
12 |
13 | let try_getval ini section value =
14 | ini >>= fun ini' ->
15 | try Some (ini'#getval section value)
16 | with _ -> None
17 |
18 | let create oasis opam name =
19 | let prompt_and_create () =
20 | let name = match name with
21 | | None ->
22 | let cwd = Sys.getcwd () in
23 | let default_dir = String.rsplit cwd ~by:"/" |> snd in
24 | prompt_default "Package name?" default_dir
25 | | Some name -> name
26 | and version =
27 | let default_ver = "1.0.0" in
28 | prompt_default "Package version?" default_ver
29 | and license = prompt_default "Please choose a license:" "PROP"
30 | and gitconfig =
31 | try
32 | let home = Sys.getenv "HOME" in
33 | Some (new Inifiles.inifile (home ^ "/.gitconfig"))
34 | with _ -> None in
35 | let author_name =
36 | let default_name = try_getval gitconfig "user" "name" in
37 | prompt_default "Author name?" (default "" default_name)
38 | and author_email =
39 | let default_email = try_getval gitconfig "user" "email" in
40 | prompt_default "Author email?" (default "" default_email)
41 | and homepage = prompt_or_empty "Project homepage URL? "
42 | and synopsis = default "" (LNoise.linenoise "Project synopsis? ") (* Don't print "[default: ...]"! *)
43 | and package_type =
44 | let get_option = function
45 | | "l" | "L" | "lib" | "Lib" | "library" | "Library" -> Some (`Lib [])
46 | | "e" | "E" | "exe" | "Exe" | "executable" | "Executable" -> Some (`Exe "")
47 | | s -> None in
48 | let rec get_input () =
49 | let input = LNoise.linenoise "What does the package build? [Library/Executable] " in
50 | match input >>= get_option with
51 | | Some option -> option
52 | | None -> print_endline "Please enter valid input!"; get_input () in
53 | get_input () in
54 | let meta = Metafile.{
55 | name; version; license; homepage; synopsis; package_type; dependencies = [];
56 | author = {username = author_name; email = author_email}
57 | } in Metafile.save_meta meta;
58 | meta in
59 | if Sys.file_exists ".opamcreate" then begin
60 | print_string "Some files have already been generated. This will overwrite the current repository. \
61 | Are you sure you want to continue? [Y/n] ";
62 | flush stdout;
63 | match input_char stdin with
64 | | 'N' | 'n' -> None
65 | | _ -> Some (prompt_and_create ())
66 | end else Some (prompt_and_create ())
67 |
--------------------------------------------------------------------------------
/templates/.merlin:
--------------------------------------------------------------------------------
1 | # This file was auto-generated by `ogen`.
2 | # Do not edit this by hand, as all changes will be
3 | # reverted upon the next run of `ogen`.
4 |
5 | S %s
6 | B %s
7 | PKG %s
8 | EXT %s
9 | FLG %s
10 |
--------------------------------------------------------------------------------
/templates/_oasis:
--------------------------------------------------------------------------------
1 | # This file was auto-generated by `ogen`.
2 | # Do not edit this by hand, as all changes will be
3 | # reverted upon the next run of `ogen`.
4 |
5 | Name: %s
6 | Version: %s
7 | Synopsis: %s
8 | Authors: %s <%s>
9 | License: %s
10 |
11 | OASISFormat: 0.4
12 | BuildTools: ocamlbuild
13 | Plugins: META (0.4), DevFiles (0.4)
14 |
15 | %s "%s"
16 | Path: %s
17 | %s
18 | CompiledObject: best
19 | BuildDepends: %s
20 |
--------------------------------------------------------------------------------
/templates/opam:
--------------------------------------------------------------------------------
1 | # This file was auto-generated by `ogen`.
2 | # Do not edit this by hand, as all changes will be
3 | # reverted upon the next run of `ogen`.
4 |
5 | opam-version: "1.2"
6 | maintainer: "%s <%s>"
7 | authors: "%s <%s>"
8 | homepage: "%s"
9 | bug-reports: "%s"
10 | license: "%s"
11 | dev-repo: "%s"
12 | build: [
13 | ["./configure" "--prefix=%%{prefix}%%"]
14 | [make]
15 | ]
16 | install: [make "install"]
17 | remove: ["ocamlfind" "remove" "%s"]
18 | depends: [
19 | "ocamlfind" {build}
20 | "oasis" {build}
21 | %s
22 | ]
23 |
--------------------------------------------------------------------------------
/test/.merlin:
--------------------------------------------------------------------------------
1 | # This file was auto-generated by `ogen`.
2 | # Do not edit this by hand, as all changes will be
3 | # reverted upon the next run of `ogen`.
4 |
5 | S src/
6 | B _build/src/
7 | PKG batteries
8 | EXT
9 | FLG
10 |
--------------------------------------------------------------------------------
/test/.ogen:
--------------------------------------------------------------------------------
1 | {
2 | "name": "test",
3 | "version": "1.0.0",
4 | "license": "GPL",
5 | "author": { "username": "nv-vn", "email": "nv@cock.li" },
6 | "homepage": "https://github.com/nv-vn/ogen",
7 | "synopsis": "A test project for ogen",
8 | "package_type": [ "Exe", "main.ml" ],
9 | "dependencies": [
10 | {
11 | "package_name": "batteries",
12 | "constraints": [ "And", [ "GEq", "2.0.0" ], [ "Less", "3.0.0" ] ]
13 | }
14 | ]
15 | }
16 |
--------------------------------------------------------------------------------
/test/_oasis:
--------------------------------------------------------------------------------
1 | # This file was auto-generated by `ogen`.
2 | # Do not edit this by hand, as all changes will be
3 | # reverted upon the next run of `ogen`.
4 |
5 | Name: test
6 | Version: 1.0.0
7 | Synopsis: A test project for ogen
8 | Authors: nv-vn
9 | License: GPL
10 |
11 | OASISFormat: 0.4
12 | BuildTools: ocamlbuild
13 | Plugins: META (0.4), DevFiles (0.4)
14 |
15 | Executable "test"
16 | Path: src/
17 | MainIs: main.ml
18 | CompiledObject: best
19 | BuildDepends: batteries
20 |
--------------------------------------------------------------------------------
/test/opam:
--------------------------------------------------------------------------------
1 | # This file was auto-generated by `ogen`.
2 | # Do not edit this by hand, as all changes will be
3 | # reverted upon the next run of `ogen`.
4 |
5 | opam-version: "1.2"
6 | maintainer: "nv-vn "
7 | authors: "nv-vn "
8 | homepage: "https://github.com/nv-vn/ogen"
9 | bug-reports: "https://github.com/nv-vn/ogen/issues"
10 | license: "GPL"
11 | dev-repo: "https://github.com/nv-vn/ogen.git"
12 | build: [
13 | ["./configure" "--prefix=%{prefix}%"]
14 | [make]
15 | ]
16 | install: [make "install"]
17 | remove: ["ocamlfind" "remove" "test"]
18 | depends: [
19 | "ocamlfind" {build}
20 | "oasis" {build}
21 | "batteries" {>= "2.0.0" & < "3.0.0"}
22 | ]
23 |
--------------------------------------------------------------------------------
/test/src/main.ml:
--------------------------------------------------------------------------------
1 | let () = ()
--------------------------------------------------------------------------------