objcgic - An Objective-C binding of cgic

Warning

objcgic is still experimental.

System Requirements

• Clang or GCC with Objective-C support
• Cocoa or GNUstep

Tested against GNUStep on openSUSE Leap 15.2. It should work on MacOS as well.

cgic itself is not needed because the repo bundles its snapshot.

Usage

Clone the repo:

$ git clone https://github.com/cwchentw/objcgic.git my-cgi-script

Change the working directory to the root of my-cgi-script:

$ cd my-cgi-script

Implement your CGI script in cgiMain function of OCGIMain.m.

Compile the repo:

$ make CGI_PROGRAM=index.cgi

The default value of CGI_PROGRAM is index.cgi on non-Windows platforms but index.exe on Windows.

If your GNUstep is located on any location other than /usr/GNUstep, set the include path and the library path of your local GNUstep:

$ make GNUSTEP_INCLUDE=/path/to/GNUstep/System/Library/Headers GNUSTEP_LIB=/path/to/GNUstep/System/Library/Libraries

The layout of your local GNUstep may vary. Adjust these variables accordingly.

If your build command becomes too long, consider to set these variables in build and clean and run make through these scripts instead.

Because of the design of cgic, you have to use objcgic on the basis of one CGI script per repo.

If you want to save your own CGI script, push it remotely to a repo other than this one:

$ git remote set-url origin path/to/remote/git/repo.git
$ git push

Update

Backup OCGIMain.m, build, clean and any other modified files. Afterwards, pull this repo again:

$ git pull https://github.com/cwchentw/objcgic.git

Git will merge updated code automatically for you, which should not require any manual intervention. If any conflict bewteen code occurs, fix it by yourself.

Project Parameters

• CGI_PROGRAM: The name of the CGI program, default to index.cgi
• CGI_ENCODING: The encoding of the CGI program, default to NSUTF8StringEncoding
• GNUSTEP_INCLUDE: The path of GNUstep headers, default to /usr/GNUstep/System/Library/Headers
• GNUSTEP_LIB: The path of GNUstep libraries, default to /usr/GNUstep/System/Library/Libraries

Example

See cgi-hello-objcgic.

API Documentation

Pending.

Note

The version of cgic snapshot in this repo is 2.08.

Originally, cgic append two lines of newline to the header of a HTTP response. We may use multiple header informations in a response; therefore, we write our own +status:message: and +contentType: of OCGIHeader class. Now, the two messages only render one line of newline to standard output.

For better compatibility between libobjc and GNUstep, we use the libobjc of GCC on non-Apple platforms.

Copyright

Copyright (c) 2020-2021, ByteBard. Licensed under MIT, the same license as cgic itself.