Difference between revisions of "Library Reference"

From wiki.visual-prolog.com

(Created page with "The reference to the standard Visual Prolog library, the Prolog Foundation Classes, is contained within Visual Prolog itself. This ensures that you will always be viewing the...")
 
(revised)
Line 1: Line 1:
The reference to the standard Visual Prolog library, the Prolog Foundation Classes, is contained within Visual Prolog itself. This ensures that you will always be viewing the correct documentation for the version of Visual Prolog you are using. PDC have requested that the PFC documentation is not placed on the wiki.
+
The reference to the standard Visual Prolog library, the Prolog Foundation Classes, is contained within Visual Prolog itself. This ensures that you will always be viewing the correct documentation for the version of Visual Prolog you are using.
  
 
To view the Library Reference for your copy of Visual Prolog, follow the steps below:
 
To view the Library Reference for your copy of Visual Prolog, follow the steps below:
Line 5: Line 5:
 
=== From within Visual Prolog ===
 
=== From within Visual Prolog ===
  
* Create a project and open one of its source files (<code>.pro</code> files) in the text editor.
+
* Create a project and open one of its source files (<vp>.pro</vp> files) in the text editor.
 
* Place the text cursor over the name of a PFC library or predicate and press F1.
 
* Place the text cursor over the name of a PFC library or predicate and press F1.
  
 
If pressing F1 opens this Wiki on a page related to getting started or the text editor, then the text cursor was not over the name of a PFC library or predicate when you pressed F1. (Note that the '''text''' cursor must be over the name, not the '''mouse''' cursor.)
 
If pressing F1 opens this Wiki on a page related to getting started or the text editor, then the text cursor was not over the name of a PFC library or predicate when you pressed F1. (Note that the '''text''' cursor must be over the name, not the '''mouse''' cursor.)
  
If you are writing a new program or learning Visual Prolog, you can place the cursor on the word <code>core</code> of the <code>open core</code> line at the top of the project template. Once the Library Reference is open you can view the documentation for any class.
+
If you are writing a new program or learning Visual Prolog, you can place the cursor on the word <vp>core</vp> of the <vp>open core</vp> line at the top of the project template. Once the Library Reference is open you can view the documentation for any class.
  
 
=== Without Visual Prolog ===
 
=== Without Visual Prolog ===
  
If you wish to browsre the PFC reference without connecting to the Visual Prolog IDE, you can find it by opening the directory where you installed Visual Prolog (usually <code>\Program Files (x86)\Visual Prolog 9</code> or the appropriate version number) and looking in the subfolder <code>`appData\doc`</code>. Double clicking the file <code>vip.chm</code> will open the Library Reference.
+
If you wish to browsre the PFC reference without connecting to the Visual Prolog IDE, you can find it by opening the directory where you installed Visual Prolog (usually <vp>\Program Files (x86)\Visual Prolog 9</vp> or the appropriate version number) and looking in the subfolder <vp>`appData\doc`</vp>. Double clicking the file <vp>vip.chm</vp> will open the Library Reference.
 
 
== List of Packages ==
 
 
 
The list of PFC libraries is shown below. These give an overview of the functionality available in PFC and can be used in the editor to open the documentation on each one.
 
 
 
* <code>5xVip</code> contains predicates for compatibility with Visual Prolog v5.
 
* <code>action</code> provides standard classes for passing event messages between listeners.
 
* <code>application</code> provides support for calling external processes or foreign DLLs.
 
* <code>asynchronous</code> supports asynchronous networking via winSock.
 
* <code>basis</code> provides base classes for iterators, cancelable operations and disposable resources.
 
* <code>binary</code> provides support for raw binary data.
 
* <code>boolean</code> provides support for C-style int-booleans and logical operations.
 
* <code>chainDB</code> contains support for external databases.
 
* <code>codePageId</code> contains constants representing standard code pages.
 
* <code>collection</code> contains standard classes for maps, queues, trees and sets.
 
* <code>commandLineParser</code> contains support for parsing command line options.
 
* <code>communications</code> contains support for pipes and synchronous sockets.
 
* <code>console</code> provides console I/O.
 
* <code>cryptography</code> provides support for encryption and decryption, hashing, and also base64 encoding.
 
* <code>dataType</code> contains support for disjoint sets.
 
* <code>environment</code> provides support for manipulating environment variables.
 
* <code>event</code> provides fully general purpose event message passing with variable numbers of parameters.
 
* <code>exception</code> holds the basic exception classes.
 
* <code>fileSystem</code> contains file operations.
 
* <code>gui</code> contains GUI support.
 
* <code>guid</code> provides support for manipulating Globally Unique IDs (GUIDs)
 
* <code>hash</code> provides incremental hashing.
 
* <code>htmlHelp</code> provides an interface to the Microsoft HTML Help engine, as used to display the Library Reference.
 
* <code>InternetExplorer</code> contains classes for interfacing with web browsers.
 
* <code>list</code> contains standard list manipulation predicates.
 
* <code>log</code> provides support for logging to the console, databases, streams, or files.
 
* <code>math</code> contains standard math operations.
 
* <code>memory</code> allows direct C-style manipulation of system memory.
 
* <code>multiThread</code> provides support for multithreaded applications.
 
* <code>namedValue</code> contains support for lists of named values.
 
* <code>ODBC</code> provides connections to ODBC databases.
 
* <code>pie</code> contains the Prolog Inference Engine.
 
* <code>presenter</code> contains support for [[Presenters]].
 
* <code>printing</code> provides support for print jobs.
 
* <code>profile</code> provides support for execution profiling.
 
* <code>programControl</code> allows direct control over the program's execution flow.
 
* <code>reflection</code> provides support for reflection of defined predicates.
 
* <code>regEx</code> provides support for regular expression matching.
 
* <code>registry</code> provides support for manipulating the Windows registry.
 
* <code>service</code> and <code>serviceImplementation</code> provide support for remotely executed services.
 
* <code>shellDDEServer</code> provides connection with Windows Explorer (the file browser, distinct from Internet Explorer)
 
* <code>smapi</code> provides an interface to Windows' SMAPI interface.
 
* <code>std</code> provides predicates for looping, likely used together with <code>foreach</code>.
 
* <code>stream</code> provides generic stream support.
 
* <code>string</code> and <code>string8</code> provide support for Unicode and ASCII strings respectively.
 
* <code>syntax</code> contains predicates supporting the [[LALR Parser Generator]].
 
* <code>systemTray</code> provides support for the Windows System Tray.
 
* <code>templateExpander</code> provides support for defining output templates.
 
* <code>testSupport</code> provides support for automated testing.
 
* <code>time</code> contains date/time handling.
 
* <code>timingStatistics</code> provides code for timing sections of the program.
 
* <code>vpi</code> provides further GUI support.
 
* <code>watchDirectory</code> allows a file system directory to be watched for changes.
 
* <code>web</code> contains support for XHTML, XML, JSON and MIME, an HTTP client and an interface to CGI.
 
* <Code>windowsApi</code> contains predicates for directly calling the Windows API.
 

Revision as of 22:59, 22 May 2019

The reference to the standard Visual Prolog library, the Prolog Foundation Classes, is contained within Visual Prolog itself. This ensures that you will always be viewing the correct documentation for the version of Visual Prolog you are using.

To view the Library Reference for your copy of Visual Prolog, follow the steps below:

From within Visual Prolog

  • Create a project and open one of its source files (.pro files) in the text editor.
  • Place the text cursor over the name of a PFC library or predicate and press F1.

If pressing F1 opens this Wiki on a page related to getting started or the text editor, then the text cursor was not over the name of a PFC library or predicate when you pressed F1. (Note that the text cursor must be over the name, not the mouse cursor.)

If you are writing a new program or learning Visual Prolog, you can place the cursor on the word core of the open core line at the top of the project template. Once the Library Reference is open you can view the documentation for any class.

Without Visual Prolog

If you wish to browsre the PFC reference without connecting to the Visual Prolog IDE, you can find it by opening the directory where you installed Visual Prolog (usually \Program Files (x86)\Visual Prolog 9 or the appropriate version number) and looking in the subfolder `appData\doc`. Double clicking the file vip.chm will open the Library Reference.