This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/Logtalk/manuals/refman/builtins/logtalk_compile2.html
pmoura 9fe4d26c59 Logtalk 2.27.0 files.
git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@1539 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
2006-02-10 17:44:05 +00:00

85 lines
3.8 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="content-type" content="application/xml+xhtml; charset=utf-8" />
<title>Logtalk built-in predicate: logtalk_compile/2</title>
<link rel="stylesheet" href="../../screen.css" type="text/css" media="screen"/>
<link rel="stylesheet" href="../../print.css" type="text/css" media="print"/>
</head>
<body>
<div class="top-left">Logtalk reference manual</div>
<div class="top-right">Built-in predicate: logtalk_compile/2</div>
<div class="bottom-left"><span class="page"/></div>
<div class="bottom-right"><span class="page"/></div>
<div class="navtop"><a href="../../index.html">contents</a> &gt; <a href="../index.html">reference manual</a> &gt; <a href="../index.html#builtins">built-in predicates</a></div>
<h2 class="code">logtalk_compile/2</h2>
<h4>Description</h4>
<pre>logtalk_compile(File, Flags)
logtalk_compile(Files, Flags)</pre>
<p>
Compiles to disk a source file or a list of source files using a list of flag values. The Logtalk file name extension (by default, <code>.lgt</code>) must be omitted. Note that the first argument is a source file name or a list of source file names, not file paths. In other words, the files must exist in the current working directory, unless library notation is used.
</p>
<p>
For a description of the available compiler flags, please <a href="../../userman/running.html#flags">consult</a> the User Manual.
</p>
<p>
Note that only the errors related to problems in the predicate arguments are listed below. Other exceptions may be thrown by the compiler if any of the compiled entities contain syntax errors.
</p>
<h4>Template and modes</h4>
<pre>logtalk_compile(@source_file_names, @list)</pre>
<h4>Errors</h4>
<dl class="errors">
<dt>File is a variable:</dt>
<dd><code>instantiation_error</code></dd>
<dt>Files is a variable or a list with an element which is a variable:</dt>
<dd><code>instantiation_error</code></dd>
<dt>File, or an element File of the Files list, is neither a variable nor an entity file name nor a library entity file name:</dt>
<dd><code>type_error(source_file_name, File)</code></dd>
<dt>File, or an element File of the Files list, is a compound term but not a library entity file name:</dt>
<dd><code>type_error(library_source_file_name, Entity)</code></dd>
<dt>File or an element File of the Files list does not exist in the current working directory or in the specified library directory:</dt>
<dd><code>existence_error(file, File)</code></dd>
<dt>Entity library does not exist:</dt>
<dd><code>existence_error(library, Library)</code></dd>
<dt>Flags is a variable:</dt>
<dd><code>instantiation_error</code></dd>
<dt>Flags is neither a variable nor a proper list:</dt>
<dd><code>type_error(list, Flags)</code></dd>
<dt>An element Flag of the Flags list is not valid:</dt>
<dd><code>type_error(compiler_flag, Flag)</code></dd>
</dl>
<h4>Examples</h4>
<pre>| ?- logtalk_compile(list, []).
| ?- logtalk_compile(types(tree), [xmlspec(xsd)]).
| ?- logtalk_compile([listp, list], [xml(off), plredf(warning)]).</pre>
<div class="footer">
<div class="navbottom"><a href="logtalk_compile1.html">previous</a> | <a href="../../glossary.html">glossary</a> | <a href="logtalk_load1.html">next</a></div>
<div class="copyright">Copyright &copy; <a href="mailto:pmoura@logtalk.org">Paulo Moura</a> &mdash; <a href="http://www.logtalk.org">Logtalk.org</a></div>
<div class="footnote">
<span class="validators"><a href="http://validator.w3.org/check/referer">XHTML</a> + <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a></span>
<span class="date">Last updated on: November 16, 2005</span>
</div>
</div>
</body>
</html>