Skip to content

psyomn/agen

Repository files navigation

AGEN

This is a small, and stupid tool for command line users programming in Ada. It generates boilerplate code for you.

Building

To build the project, you need to go into the root directory, and locate the gnatmake (.gpr) file. Once you're there, run the following:

gnatmake -P agen -p

Commands

To create a new project template, you can run the following command:

$ agen new project my-project

The above will create the project with a template gnatmake file. There is a provided hello world program that you can compile if you want to make sure that everything is alright - so you can go ahead and compile the newly generated project.

If you want to generate the code for a function:

$ agen print function funcname:string param1:string param2:int

or the shorter equivalent:

$ agen p fn funcname:string param1:string param2:int

Which will yield:

-- @author simon
-- @param world
-- @date 2014-04-16 (iso)
function hello(world : string) return string is
-- Enter your contents here...
begin
end hello;

Generating code for a procedure is similar:

$ agen print procedure myproc param1:int

or the shorter equivalent:

$ agen p proc myproc param1:int

and yield the following results:

-- @author simon
-- @param param1
-- @date 2014-04-16 (iso)
procedure myproc(param1 : int) is
-- Enter your contents here...
begin
end myproc;

Notice that you don't need to specify a return for the proc, in the command. You could provide one, but it would be ignored.

You can also quickly generate comments. For example if you want to document a function that was not previously documented, you can enter the parameters in the following command:

$ agen p cmm param1:int param2:int

and yield:

-- @author simon
-- @param param1
-- @param param2
-- @date 2014-04-16 (iso)

Releases

No releases published

Packages

No packages published

Languages