1Lucy::Docs::DevGuide(3pUms)er Contributed Perl DocumentatLiuocny::Docs::DevGuide(3pm)
2
3
4

NAME

6       Lucy::Docs::DevGuide - Quick-start guide to hacking on Apache Lucy.
7

DESCRIPTION

9       The Apache Lucy code base is organized into roughly four layers:
10
11       •   Charmonizer - compiler and OS configuration probing.
12
13       •   Clownfish - header files.
14
15       •   C - implementation files.
16
17       •   Host - binding language.
18
19       Charmonizer is a configuration prober which writes a single header
20       file, “charmony.h”, describing the build environment and facilitating
21       cross-platform development.  It’s similar to Autoconf or Metaconfig,
22       but written in pure C.
23
24       The “.cfh” files within the Lucy core are Clownfish header files.
25       Clownfish is a purpose-built, declaration-only language which
26       superimposes a single-inheritance object model on top of C which is
27       specifically designed to co-exist happily with variety of “host”
28       languages and to allow limited run-time dynamic subclassing.  For more
29       information see the Clownfish docs, but if there’s one thing you should
30       know about Clownfish OO before you start hacking, it’s that method
31       calls are differentiated from functions by capitalization:
32
33           Indexer_Add_Doc   <-- Method, typically uses dynamic dispatch.
34           Indexer_add_doc   <-- Function, always a direct invocation.
35
36       The C files within the Lucy core are where most of Lucy’s low-level
37       functionality lies.  They implement the interface defined by the
38       Clownfish header files.
39
40       The C core is intentionally left incomplete, however; to be usable, it
41       must be bound to a “host” language.  (In this context, even C is
42       considered a “host” which must implement the missing pieces and be
43       “bound” to the core.)  Some of the binding code is autogenerated by
44       Clownfish on a spec customized for each language.  Other pieces are
45       hand-coded in either C (using the host’s C API) or the host language
46       itself.
47
48
49
50perl v5.38.0                      2023-07-20         Lucy::Docs::DevGuide(3pm)
Impressum