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

95 lines
3.8 KiB
HTML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<?xml-stylesheet type="text/css" href="../../styles.css" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>Logtalk built-in predicate: logtalk_compile/2</title>
<link rel="stylesheet" href="../../styles.css" type="text/css" />
</head>
<body>
<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><code>logtalk_compile/2</code></h2>
<h4>Description</h4>
<blockquote>
<pre>logtalk_compile(Entity, Flags)
logtalk_compile(Entities, Flags)</pre>
<p>
Compiles to disk an entity, a list of entities (objects, protocols, or categories), or a source metafile using a list of flag values. The Logtalk file name extension (by default, <code>.lgt</code> for entity source files and <code>.mlgt</code> for source metafiles) should be omitted. Note that the first argument is a list of entity/file names, not file paths. In other words, the files must exist in the current working directory.
</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 contains syntax errors.
</p>
</blockquote>
<h4>Template and modes</h4>
<blockquote>
<pre>logtalk_compile(@entity_file_name, @list)
logtalk_compile(@entity_file_name_list, @list)</pre>
</blockquote>
<h4>Errors</h4>
<blockquote>
<dl>
<dt>Entity is a variable:</dt>
<dd><code>instantiation_error</code></dd>
<dt>Entities is a variable or a list with an element which is a variable:</dt>
<dd><code>instantiation_error</code></dd>
<dt>Entity, or an element Entity of the Entities list, is neither a variable nor an entity file name nor a library entity file name:</dt>
<dd><code>type_error(entity_file_name, Entity)</code></dd>
<dt>Entity, or an element Entity of the Entities list, is a compound term but not a library entity file name:</dt>
<dd><code>type_error(library_entity_file_name, Entity)</code></dd>
<dt>Entity or an element Entity of the Entities list does not exist in the current working directory or in the specified library directory:</dt>
<dd><code>existence_error(entity, Entity)</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>
</blockquote>
<h4>Examples</h4>
<blockquote>
<pre>| ?- logtalk_compile(list, []).
| ?- logtalk_compile(types(tree), [xmlspec(xsd)]).
| ?- logtalk_compile([listp, list], [xml(off), plredf(warning)]).</pre>
</blockquote>
<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="footer">
<p><span class="bleft"><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="bright">Last updated on: February 6, 2005</span></p>
</div>
</body>
</html>