load-cg-source-file-info

Arguments: &key (system :all)

Loads source file information for the Common Graphics and/or IDE source code, which allows the Find Definitions facility to locate particular CG or IDE definitions and display them in the editor. This may be useful when writing a Common Graphics application if you need to see exactly what CG itself is doing.

This function will work only if the CG and IDE source code has been obtained from Franz and installed at the standard location, which is in new src/cg/ and src/ide/ subdirectories of the main Allegro directory.

The system keyword argument may be either :cg to load only the CG source file info, :ide to load only the IDE source file info, or :all to load both. The default is :all. The IDE code is probably of less interest, because an application would normally never call IDE code.

If you use the Search | Find Definition (or Search | Quick Find Definition) command to edit a CG or IDE definition without first calling this function, then a dialog will appear that explains the situation. If you have already installed the CG/IDE source code, the dialog offers to call load-cg-source-file-info for you. After calling the function, you will need to do the Find Definitions command again to locate the source code.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.