Build::Hopen - A build generator with first-class edges and explicit dependencies
Input is the last-sorting file in . matching *.hopen, unless you specify otherwise. That way you can call your build file .hopen if you want it hidden, or z.hopen if you want it to sort below all your other files. Sort order is Lua's <, which is by byte value.
.
*.hopen
.hopen
z.hopen
<
Output is a build file for a build system (Ninja or Make will be first). You will eventually be able to pick a generator, a la CMake. The invoker will put the selected generator's path first in @INC, but other than that it's all straight Perl.
@INC
Easiest: install cpanminus if you don't have it - see https://metacpan.org/pod/App::cpanminus#INSTALLATION. Then run cpanm Build::Hopen.
cpanminus
cpanm Build::Hopen
Manually: clone or untar into a working directory. Then, in that directory,
perl Makefile.PL make make test
... and if all the tests pass,
make install
If some of the tests fail, please check the issues and file a new one if no one else has reported the problem yet.
Set to truthy to get debug output on stderr from hopen's internals.
Convert a scalar to a Boolean as Perl, except:
Falsy
/^(false|off|no)$/i
Truthy
"0"
So false, off, no, empty string, undef, and numeric 0 are falsy, and all other values (including string '0') are truthy.
false
off
no
undef
0
'0'
Creates a new Build::Hopen instance. For example:
hnew DAG => 'foo';
is the same as
Build::Hopen::G::DAG->new( name => 'foo' );
If the provided name does not include a double-colon, it is first tried after Build::Hopen::G::. It is then tried in Build::Hopen:: and as a complete package name. The first one that succeeds is used.
Build::Hopen::G::
Build::Hopen::
The first parameter must be a part of a class name, and the second parameter must be the name of the new instance. All other parameters are passed unchanged to the relevant constructor.
Log information if "$VERBOSE" is set. Usage:
hlog { <list of things to log> };
The items in the list are joined by ' ' on output, and a '\n' is added. Each line is prefixed with '# ' for the benefit of test runs.
' '
'\n'
'# '
- C<Op>: A class representing an operation - C<Op:run()> takes a table of inputs and returns a table of outputs. - C<Op:describe()> returns a table listing those inputs and outputs.
After the hopen file is processed, cycles are detected and reported as errors. *(TODO change this to support LaTeX multi-run files?)* Then the DAG is traversed, and each operation writes the necessary information to the file being generated.
hopen
You can find documentation for this module with the perldoc command.
perldoc Build::Hopen perldoc hopen
You can also look for information at:
GitHub (report bugs here)
https://github.com/cxw42/hopen
MetaCPAN
https://metacpan.org/release/Build-Hopen
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Build-Hopen
CPAN Ratings
https://cpanratings.perl.org/d/Build-Hopen
Luke
a bit of Ant
a tiny bit of Buck
my own frustrations working with CMake.
Copyright (C) 2018 Christopher White, <cxwembedded at gmail.com>
<cxwembedded at gmail.com>
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
To install Build::Hopen, copy and paste the appropriate command in to your terminal.
cpanm
CPAN shell
perl -MCPAN -e shell install Build::Hopen
For more information on module installation, please visit the detailed CPAN module installation guide.