1 ! Copyright (C) 2009 Jeremy Hughes.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: help.markup help.syntax kernel strings words.symbol sequences ;
4 IN: alien.inline.compiler
7 { $var-description "A symbol representing C source." } ;
10 { $var-description "A symbol representing C++ source." } ;
12 HELP: compile-to-library
14 { "lang" symbol } { "args" sequence } { "contents" string } { "name" string }
16 { $description "Compiles and links " { $snippet "contents" } " into a shared library called " { $snippet "libname.suffix" }
17 "in " { $snippet "resource:alien-inline-libs" } ". " { $snippet "suffix" } " is OS specific. "
18 { $snippet "args" } " is a sequence of arguments for the linking stage." }
21 "C and C++ are the only supported languages."
22 { "Source and object files are placed in " { $snippet "resource:temp" } "." } }
30 { $description "Returns a compiler name based on OS and source language." }
31 { $see-also compiler-descr } ;
36 { "descr" "a process description" }
38 { $description "Returns a compiler process description based on OS and source language." }
39 { $see-also compiler } ;
41 HELP: inline-library-file
44 { "path" "a pathname string" }
46 { $description "Appends " { $snippet "name" } " to the " { $link inline-libs-directory } "." } ;
48 HELP: inline-libs-directory
50 { "path" "a pathname string" }
52 { $description "The directory where libraries created using " { $snippet "alien.inline" } " are stored." } ;
57 { "path" "a pathname string" }
59 { $description "Converts " { $snippet "name" } " into a full path to the corresponding inline library." } ;
65 { $description "The appropriate shared library suffix for the current OS." } ;
69 { "lang" "a language" }
72 { $description "Returns part of a process description. OS dependent." } ;
74 ARTICLE: "alien.inline.compiler" "Inline C compiler"
75 { $vocab-link "alien.inline.compiler" }
78 ABOUT: "alien.inline.compiler"