badvpn/ncd/NCDBuildProgram.h

50 lines
2.3 KiB
C

/**
* @file NCDBuildProgram.h
* @author Ambroz Bizjak <ambrop7@gmail.com>
*
* @section LICENSE
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the author nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef NCD_BUILD_PROGRAM_H
#define NCD_BUILD_PROGRAM_H
#include <misc/debug.h>
#include <ncd/NCDAst.h>
/**
* Builds an NCD program in AST form suitable for passing to {@link NCDInterpreter},
* by opening and parsing it, as well as recursively processing any included files.
* The resulting program will not contain any 'include' or 'include_guard' elements;
* these will be resolved and removed.
*
* @param file_path path to the main file of the program
* @param out_program on success, *out_program will contain the resulting program.
* On failure, *out_program will be unchanged.
* @return 1 on success, 0 on failure
*/
int NCDBuildProgram_Build (const char *file_path, NCDProgram *out_program) WARN_UNUSED;
#endif