The Logtalk Handbook

Contents

• User Manual
  • Declarative object-oriented programming
  • Main features
    • Integration of logic and object-oriented programming
    • Integration of event-driven and object-oriented programming
    • Support for component-based programming
    • Support for both prototype and class-based systems
    • Support for multiple object hierarchies
    • Separation between interface and implementation
    • Private, protected and public inheritance
    • Private, protected and public object predicates
    • Parametric objects
    • High level multi-threading programming support
    • Smooth learning curve
    • Compatibility with most Prolog systems and the ISO standard
    • Performance
    • Logtalk scope
  • Nomenclature
    • Prolog nomenclature
    • Smalltalk nomenclature
    • C++ nomenclature
    • Java nomenclature
    • Python nomenclature
  • Messages
    • Operators used in message-sending
    • Sending a message to an object
    • Delegating a message to an object
    • Sending a message to self
    • Broadcasting
    • Calling imported and inherited predicates
    • Message sending and event generation
    • Sending a message from a module
    • Message sending performance
  • Objects
    • Objects, prototypes, classes, and instances
    • Defining a new object
    • Parametric objects
    • Finding defined objects
    • Creating a new object in runtime
    • Abolishing an existing object
    • Object directives
    • Object relationships
    • Object properties
    • Built-in objects
    • Multi-threading applications
  • Protocols
    • Defining a new protocol
    • Finding defined protocols
    • Creating a new protocol in runtime
    • Abolishing an existing protocol
    • Protocol directives
    • Protocol relationships
    • Protocol properties
    • Implementing protocols
    • Built-in protocols
    • Multi-threading applications
  • Categories
    • Defining a new category
    • Hot patching
    • Finding defined categories
    • Creating a new category in runtime
    • Abolishing an existing category
    • Category directives
    • Category relationships
    • Category properties
    • Importing categories
    • Calling category predicates
    • Parametric categories
    • Built-in categories
    • Multi-threading applications
  • Predicates
    • Reserved predicate names
    • Declaring predicates
    • Defining predicates
    • Definite clause grammar rules
    • Built-in methods
    • Predicate properties
    • Finding declared predicates
    • Calling Prolog predicates
    • Defining Prolog multifile predicates
    • Asserting and retracting Prolog predicates
  • Inheritance
    • Protocol inheritance
    • Implementation inheritance
    • Public, protected, and private inheritance
    • Multiple inheritance
    • Composition versus multiple inheritance
  • Event-driven programming
    • Definitions
    • Event generation
    • Communicating events to monitors
    • Performance concerns
    • Monitor semantics
    • Activation order of monitors
    • Event handling
  • Multi-threading programming
    • Enabling multi-threading support
    • Enabling objects to make multi-threading calls
    • Multi-threading built-in predicates
    • One-way asynchronous calls
    • Asynchronous calls and synchronized predicates
    • Synchronizing threads through notifications
    • Threaded engines
    • Multi-threading performance
  • Error handling
    • Raising Exceptions
    • Type-checking
    • Expected terms
    • Compiler warnings and errors
    • Runtime errors
  • Reflection
    • Structural reflection
    • Behavioral reflection
  • Writing and running applications
    • Starting Logtalk
    • Running parallel Logtalk processes
    • Source files
    • Multi-pass compiler
    • Compiling and loading your applications
    • Compiler errors, warnings, and comments
    • Loader files
    • Libraries of source files
    • Settings files
    • Compiler linter
    • Compiler flags
    • Reloading source files
    • Batch processing
    • Optimizing performance
    • Portable applications
    • Conditional compilation
    • Avoiding common errors
    • Coding style guidelines
  • Printing messages and asking questions
    • Printing messages
    • Message tokenization
    • Meta-messages
    • Defining message prefixes and output streams
    • Defining message prefixes and output files
    • Intercepting messages
    • Asking questions
    • Intercepting questions
    • Multi-threading applications
  • Term and goal expansion
    • Defining expansions
    • Expanding grammar rules
    • Bypassing expansions
    • Hook objects
    • Virtual source file terms and loading context
    • Default compiler expansion workflow
    • User defined expansion workflows
    • Using Prolog defined expansions
    • Debugging expansions
  • Documenting
    • Entity documenting directives
    • Predicate documenting directives
    • Describing predicates
    • Documenting predicate exceptions
    • Processing and viewing documenting files
    • Inline formatting in comments text
    • Diagrams
  • Debugging
    • Compiling source files in debug mode
    • Procedure box model
    • Activating the debugger
    • Defining breakpoints
    • Defining log points
    • Tracing program execution
    • Debugging using breakpoints
    • Debugging commands
    • Customizing term writing
    • Context-switching calls
    • Debugging messages
    • Using the term-expansion mechanism for debugging
    • Ports profiling
    • Debug and trace events
    • Source-level debugger
  • Performance
    • Source code compilation modes
    • Source code compilation order
    • Local predicate calls
    • Calls to imported or inherited predicates
    • Calls to module predicates
    • Messages
    • Automatic expansion of built-in meta-predicates
    • Inlining
    • Generated code simplification and optimizations
    • Size of the generated code
    • Circular references
    • Debug mode overhead
    • Other considerations
  • Installing Logtalk
    • Hardware and software requirements
    • Logtalk installers
    • Source distribution
    • Distribution overview
  • Prolog integration and migration
    • Source files with both Prolog code and Logtalk code
    • Encapsulating plain Prolog code in objects
    • Converting Prolog modules into objects
    • Compiling Prolog modules as objects
    • Dealing with proprietary Prolog directives and predicates
    • Calling Prolog module predicates
    • Loading converted Prolog applications
• Reference Manual
  • Grammar
    • Entities
    • Object definition
    • Category definition
    • Protocol definition
    • Entity relations
    • Entity identifiers
    • Source files
    • Source file names
    • Terms
    • Directives
    • Clauses and goals
    • Lambda expressions
    • Entity properties
    • Predicate properties
    • Compiler flags
  • Control constructs
    • Message sending
    • Message delegation
    • Calling imported and inherited predicates
    • Calling predicates in this
    • Calling external predicates
    • Context switching calls
  • Directives
    • Source file directives
    • Conditional compilation directives
    • Entity directives
    • Predicate directives
  • Built-in predicates
    • Enumerating objects, categories and protocols
    • Enumerating objects, categories and protocols properties
    • Creating new objects, categories and protocols
    • Abolishing objects, categories and protocols
    • Objects, categories, and protocols relations
    • Event handling
    • Multi-threading
    • Multi-threading engines
    • Compiling and loading source files
    • Flags
    • Linter
  • Built-in methods
    • Logic and control
    • Execution context
    • Reflection
    • Database
    • Meta-calls
    • Error handling
    • All solutions
    • Event handling
    • Message forwarding
    • Definite clause grammar rules
    • Term and goal expansion
    • Coinduction hooks
    • Message printing
    • Question asking
• Tutorial
  • List predicates
    • Defining a list object
    • Defining a list protocol
    • Summary
  • Dynamic object attributes
    • Defining a category
    • Importing the category
    • Summary
  • A reflective class-based system
    • Defining the base classes
    • Summary
  • Profiling programs
    • Messages as events
    • Profilers as monitors
    • Summary
• FAQ
  • General
    • Why are all versions of Logtalk numbered 2.x or 3.x?
    • Why do I need a Prolog compiler to use Logtalk?
    • Is the Logtalk implementation based on Prolog modules?
    • Does the Logtalk implementation use term-expansion?
  • Compatibility
    • What are the backend Prolog compiler requirements to run Logtalk?
    • Can I use constraint-based packages with Logtalk?
    • Can I use Logtalk objects and Prolog modules at the same time?
  • Installation
    • The integration scripts/shortcuts are not working!
    • I get errors when starting up Logtalk after upgrading to the latest version!
  • Portability
    • Are my Logtalk applications portable across Prolog compilers?
    • Are my Logtalk applications portable across operating systems?
  • Programming
    • Should I use prototypes or classes in my application?
    • Can I use both classes and prototypes in the same application?
    • Can I mix classes and prototypes in the same hierarchy?
    • Can I use a protocol or a category with both prototypes and classes?
    • What support is provided in Logtalk for defining and using components?
    • What support is provided in Logtalk for reflective programming?
  • Troubleshooting
    • Using compiler options on calls to the Logtalk compiling and loading predicates does not work!
    • Gecko-based browsers (e.g., Firefox) show non-rendered HTML entities when browsing XML documenting files!
    • Compiling a source file results in errors or warnings but the Logtalk compiler reports a successful compilation with zero errors and zero warnings!
  • Usability
    • Is there a shortcut for compiling and loading source files?
    • Is there an equivalent directive to the ensure_loaded/1 Prolog directive?
    • Are there shortcuts for the make functionality?
  • Deployment
    • Can I create standalone applications with Logtalk?
  • Performance
    • Is Logtalk implemented as a meta-interpreter?
    • What kind of code Logtalk generates when compiling objects? Dynamic code? Static code?
    • How about message-sending performance? Does Logtalk use static binding or dynamic binding?
    • Which Prolog-dependent factors are most crucial for good Logtalk performance?
    • How does Logtalk performance compare with plain Prolog and with Prolog modules?
  • Licensing
    • What’s the Logtalk distribution license?
    • Can Logtalk be used in commercial applications?
    • What’s the final license for a combination of Logtalk with a Prolog compiler?
  • Support
    • Are there professional consulting, training and supporting services?
• Developer Tools
  • Overview
    • Loading the developer tools
    • Tools documentation
    • Tools common flags
    • Tools requirements
  • asdf
  • assertions
    • API documentation
    • Loading
    • Testing
    • Adding assertions to your source code
    • Automatically adding file and line context information to assertions
    • Suppressing assertion calls from source code
    • Redirecting assertion failure messages
    • Converting assertion failures into errors
  • code_metrics
    • API documentation
    • Loading
    • Testing
    • Available metrics
    • Coupling metrics
    • Halstead metric
    • UPN metric
    • Cyclomatic complexity metric
    • Usage
    • Excluding code from analysis
    • Defining new metrics
    • Third-party tools
    • Applying metrics to Prolog modules
    • Applying metrics to plain Prolog code
  • dead_code_scanner
    • API documentation
    • Loading
    • Testing
    • Usage
    • Excluding code from analysis
    • Integration with the make tool
    • Caveats
    • Scanning Prolog modules
    • Scanning plain Prolog files
  • debug_messages
    • API documentation
    • Loading
    • Testing
    • Usage
  • debugger
    • API documentation
    • Loading
    • Testing
    • Usage
    • Alternative debugger tools
    • Known issues
  • diagrams
    • Requirements
    • API documentation
    • Loading
    • Testing
    • Supported diagrams
    • Graph elements
    • Supported graph languages
    • Customization
    • Linking diagrams
    • Creating diagrams for Prolog module applications
    • Creating diagrams for plain Prolog files
    • Other notes
  • doclet
    • API documentation
    • Loading
    • Automating running doclets
    • Integration with the make tool
  • help
    • Requirements
    • API documentation
    • Loading
    • Testing
    • Supported operating-systems
    • Usage
    • Experimental features
    • Known issues
  • issue_creator
    • Requirements
    • Loading
    • Usage
    • Known issues
  • lgtdoc
    • Requirements
    • API documentation
    • Loading
    • Testing
    • Documenting source code
    • Generating documentation
    • Documentation linter checks
  • lgtunit
    • Main files
    • API documentation
    • Loading
    • Testing
    • Writing and running tests
    • Automating running tests
    • Parametric test objects
    • Test dialects
    • User-defined test dialects
    • QuickCheck
    • Skipping tests
    • Selecting tests
    • Checking test goal results
    • Testing local predicates
    • Testing non-deterministic predicates
    • Testing generators
    • Testing input/output predicates
    • Suppressing tested predicates output
    • Tests with timeout limits
    • Setup and cleanup goals
    • Test annotations
    • Test execution times and memory usage
    • Working with test data files
    • Flaky tests
    • Mocking
    • Debugging messages in tests
    • Debugging failed tests
    • Code coverage
    • Utility predicates
    • Exporting test results in xUnit XML format
    • Exporting test results in the TAP output format
    • Generating Allure reports
    • Exporting code coverage results in XML format
    • Automatically creating bug reports at issue trackers
    • Minimizing test results output
    • Help with warnings
    • Known issues
  • linter
    • Main linter checks
    • Help on linter warnings
    • Extending the linter
    • Linting Prolog modules
    • Linting plain Prolog files
  • make
    • API documentation
    • Help with warnings
  • packs
    • Requirements
    • API documentation
    • Loading
    • Testing
    • Usage
    • Registries and packs storage
    • Virtual environments
    • Registry specification
    • Registry handling
    • Registry development
    • Pack specification
    • Encrypted packs
    • Signed packs
    • Pack URLs and Single Sign-On
    • Multiple pack versions
    • Pack dependencies
    • Pack portability
    • Pack development
    • Pack handling
    • Pack documentation
    • Pinning registries and packs
    • Testing packs
    • Security considerations
    • Best practices
    • Installing Prolog packs
    • Help with warnings
    • Known issues
  • ports_profiler
    • API documentation
    • Loading
    • Testing
    • Compiling source files for port profiling
    • Generating profiling data
    • Printing profiling data reports
    • Interpreting profiling data
    • Profiling Prolog modules
    • Profiling plain Prolog code
    • Known issues
  • profiler
    • Loading
    • Testing
    • Supported backend Prolog compilers
    • Compiling source code for profiling
  • tutor
    • API documentation
    • Loading
    • Usage
  • wrapper
    • API documentation
    • Loading
    • Workflows
    • Customization
    • Current limitations
• Libraries
  • Overview
    • Library documentation
    • Loading libraries
    • Testing libraries
    • Credits
    • Other notes
  • arbitrary
    • API documentation
    • Loading
    • Testing
    • Pre-defined types
    • Usage
    • Defining new generators and shrinkers
    • Scoped generators and shrinkers
    • Reproducing sequences of arbitrary terms
    • Default size of generated terms
    • Known issues
  • assignvars
    • API documentation
    • Loading
    • Testing
  • base64
    • API documentation
    • Loading
    • Testing
    • Encoding
    • Decoding
  • basic_types
    • API documentation
    • Loading
    • Testing
  • cbor
    • Representation
    • Encoding
    • Decoding
    • API documentation
    • Loading
    • Testing
  • core
    • API documentation
    • Loading
    • Testing
  • coroutining
    • API documentation
    • Loading
    • Testing
    • Usage
  • csv
    • API documentation
    • Loading
    • Testing
    • Usage
  • dates
    • API documentation
    • Loading
  • dependents
    • API documentation
    • Loading
  • dictionaries
    • API documentation
    • Loading
    • Testing
    • Usage
    • Credits
  • dif
    • API documentation
    • Loading
    • Testing
    • Usage
  • edcg
    • API documentation
    • Loading
    • Testing
    • Usage
    • Introduction
    • Syntax
    • Declaration of Predicates
    • Declaration of Accumulators
    • Declaration of Passed Arguments
    • Additional documentation
  • events
    • API documentation
    • Loading
  • expand_library_alias_paths
    • API documentation
    • Loading
    • Usage
  • expecteds
    • API documentation
    • Loading
    • Testing
    • Usage
    • See also
  • format
    • API documentation
    • Loading
    • Testing
    • Usage
    • Portability
  • genint
    • API documentation
    • Loading
    • Testing
    • Usage
  • gensym
    • API documentation
    • Loading
    • Testing
    • Usage
  • git
    • API documentation
    • Loading
    • Testing
    • Usage
  • grammars
    • API documentation
    • Loading
    • Testing
    • Usage
  • heaps
    • API documentation
    • Loading
    • Testing
    • Credits
  • hierarchies
    • API documentation
    • Loading
    • Testing
  • hook_flows
    • API documentation
    • Loading
    • Testing
    • Usage
  • hook_objects
    • API documentation
    • Loading
    • Testing
    • Usage
  • html
    • API documentation
    • Loading
    • Testing
    • Generating a HTML document
    • Generating a HTML fragment
    • Working with callbacks to generate content
    • Working with custom elements
  • ids
    • API documentation
    • Loading
    • Testing
    • Usage
  • intervals
    • API documentation
    • Loading
    • Testing
  • java
    • API documentation
    • Loading
    • Testing
    • Usage
    • Known issues
  • json
    • API documentation
    • Loading
    • Testing
    • Representation
    • Encoding
    • Decoding
    • Known issues
  • json_lines
    • API documentation
    • Loading
    • Testing
    • Representation
    • Encoding
    • Decoding
    • Known issues
  • listing
    • API documentation
    • Loading
    • Testing
    • Usage
  • logging
    • API documentation
    • Loading
  • loops
    • API documentation
    • Loading
    • Testing
    • Usage
  • meta
    • API documentation
    • Loading
    • Testing
    • Usage
  • meta_compiler
    • API documentation
    • Loading
    • Testing
    • Usage
    • Known issues
  • mutations
    • API documentation
    • Loading
    • Testing
    • Usage
  • nested_dictionaries
    • API documentation
    • Loading
    • Testing
    • Usage
    • Curly term representation
  • optionals
    • API documentation
    • Loading
    • Testing
    • Usage
    • See also
  • options
    • API documentation
    • Loading
    • Testing
    • Usage
  • os
    • API documentation
    • Loading
    • Testing
    • Known issues
  • queues
    • API documentation
    • Loading
    • Testing
    • Usage
  • random
    • API documentation
    • Loading
    • Testing
    • Usage
  • reader
    • API documentation
    • Loading
    • Testing
  • recorded_database
    • API documentation
    • Loading
    • Testing
    • Usage
    • Known issues
  • redis
    • API documentation
    • Loading
    • Testing
    • Credits
    • Known issues
  • sets
    • API documentation
    • Loading
    • Testing
    • Usage
    • Credits
  • statistics
    • API documentation
    • Loading
    • Testing
  • term_io
    • API documentation
    • Loading
    • Testing
  • timeout
    • API documentation
    • Loading
    • Testing
    • Known issues
  • tsv
    • API documentation
    • Loading
    • Testing
    • Usage
  • types
    • API documentation
    • Loading
    • Testing
    • Type-checking
    • Defining new types
    • Examples
  • ulid
    • API documentation
    • Loading
    • Testing
    • Generating ULIDs
    • Type-checking ULIDs
  • unicode_data
    • Authors
    • License
    • Website
    • Description
    • Requirements
    • Usage
    • Known issues
    • Acknowledgements
    • Files and API Summary
  • union_find
    • API documentation
    • Loading
    • Testing
    • Usage
  • uuid
    • API documentation
    • Loading
    • Testing
    • Generating version 1 UUIDs
    • Generating version 4 UUIDs
    • Generating the null UUID
  • zippers
    • API documentation
    • Loading
    • Testing
• Ports
  • fcube
    • API documentation
    • Loading
    • Testing
  • metagol
    • API documentation
    • Loading
    • Testing
  • toychr
    • API documentation
    • Loading
    • Testing
• Contributions
  • flags
    • API documentation
    • Loading
    • Testing
  • iso8601
    • API documentation
    • Loading
    • Testing
  • pddl_parser
    • API documentation
    • Loading
    • Testing
  • verdi_neruda
  • xml_parser
    • API documentation
    • Loading
    • Testing
    • Known issues
• Glossary
• Bibliography
• Index

• Search Page