unmaintained/alien/inline/compiler/compiler-docs.factor

   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
   5
   6 HELP: C
   7 { $var-description "A symbol representing C source." } ;
   8
   9 HELP: C++
  10 { $var-description "A symbol representing C++ source." } ;
  11
  12 HELP: compile-to-library
  13 { $values
  14     { "lang" symbol } { "args" sequence } { "contents" string } { "name" string }
  15 }
  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." }
  19 { $notes
  20   { $list
  21     "C and C++ are the only supported languages."
  22     { "Source and object files are placed in " { $snippet "resource:temp" } "." } }
  23 } ;
  24
  25 HELP: compiler
  26 { $values
  27     { "lang" symbol }
  28     { "str" string }
  29 }
  30 { $description "Returns a compiler name based on OS and source language." }
  31 { $see-also compiler-descr } ;
  32
  33 HELP: compiler-descr
  34 { $values
  35     { "lang" symbol }
  36     { "descr" "a process description" }
  37 }
  38 { $description "Returns a compiler process description based on OS and source language." }
  39 { $see-also compiler } ;
  40
  41 HELP: inline-library-file
  42 { $values
  43     { "name" string }
  44     { "path" "a pathname string" }
  45 }
  46 { $description "Appends " { $snippet "name" } " to the " { $link inline-libs-directory } "." } ;
  47
  48 HELP: inline-libs-directory
  49 { $values
  50     { "path" "a pathname string" }
  51 }
  52 { $description "The directory where libraries created using " { $snippet "alien.inline" } " are stored." } ;
  53
  54 HELP: library-path
  55 { $values
  56     { "str" string }
  57     { "path" "a pathname string" }
  58 }
  59 { $description "Converts " { $snippet "name" } " into a full path to the corresponding inline library." } ;
  60
  61 HELP: library-suffix
  62 { $values
  63     { "str" string }
  64 }
  65 { $description "The appropriate shared library suffix for the current OS." } ;
  66
  67 HELP: link-descr
  68 { $values
  69     { "lang" "a language" }
  70     { "descr" sequence }
  71 }
  72 { $description "Returns part of a process description. OS dependent." } ;
  73
  74 ARTICLE: "alien.inline.compiler" "Inline C compiler"
  75 { $vocab-link "alien.inline.compiler" }
  76 ;
  77
  78 ABOUT: "alien.inline.compiler"