The Compiler API

The c8compiler.h file contains function prototypes for the Sybase CEP Compiler API, a set of functions that enable you to compile a Sybase CEP project file (.ccp) or schema file.

The primary functions in this API are the C8Compile() function and the C8RemoteCompile()C8RemoteCompile() function, which perform the same actions as the Sybase CEP compiler (c8_compiler on UNIX or c8_compiler.exe on Microsoft Windows). They translate a group of CCL statements into a form the server can use. You can specify the same options for C8Compile() as you can specify on the command line of the Sybase CEP compiler. (For a description of the command-line parameters of the c8_compiler program, see Compile a Project or a Schema File.)

The API provides additional functions that you may find useful if you want to specify options for the compiler, such as turning warning messages on or off. For a full description of these options, see Compile a Project or a Schema File, and especially the first table in that section.

The functions in the compiler API can be called from any out-of-process program. These functions may not be called from inside an in-process task, such as an in-process adapter or an in-process UDF.

The Sybase CEP CCL compiler API is shown below.

• C8Status C8Compile( const C8Char * i_input_file, const C8Char * i_output_file, const C8Char * i_workspace, const C8Char * i_load_name, const C8CompilerOptions * i_opts ); – Purpose: Compiles a CCL program.

  If non-default compiler options are needed, create an instance of C8CompilerOptions with C8CompilerOptionsCreate. Use the C8CompilerOptionsSet... methods to modify the options then pass the options to the C8Compile call and destroy them afterwards with the C8CompilerOptionsDestroy call. In general, the calls to manipulate compiler options match the compiler options as shown by executing c8_compiler --help and described in the Sybase CEP documentation.

  Note: This function only complies; it does not start executing the compiled code.

  Parameters:

  • i_input_file: The CCL project file to compile. Includes the path as well as the complete file name. The function does not assume a particular filename extension such as .ccp or .ccl.

  • i_output_file : Where to write the compiled ccx program. Includes the path as well as the complete file name. The function does not assume a particular filename extension such as .ccx. Specify a location at which the c8_client program or Sybase CEP Studio can find the file. All relative paths are relative to the current working directory of the process that calls the C8Compile function.

  • i_workspace: The workspace name.

  • i_load_name: The load name for the module. This name should be unique within the workspace. For a description of the load name, see the description of the "--name=progname" c8_compiler option in the first table in Compile a Project or a Schema File.

  • i_opts: The compiler options to use, or NULL for defaults.

  Returns: C8_OK if successful, C8_FAIL otherwise.

• C8Status C8RemoteCompile( const C8Char * i_input_file, const C8Char * i_output_file, const C8Char * i_compiler_flags, const C8Char * i_workspace, const C8Char * i_load_name, const C8CompilerUri * i_compiler_uri ); – Purpose: Compiles a CCL program. Compilation is done on the server, not the client. For more information about server-side vs. client-side compilation, see Client-side vs. Server-side Compilation.

  If non-default compiler options are needed, create an instance of C8CompilerOptions with C8CompilerOptionsCreate use the C8CompilerOptionsSet... methods to modify the options, pass the options to the C8Compile call, and destroy them afterwards with the C8CompilerOptionsDestroy call. In general, the calls to manipulate compiler options match the compiler options as shown by executing c8_compiler --help and described in the Sybase CEP documentation.

  Note: This function only complies; it does not start executing the compiled code.

  Parameters:

  • i_input_file: The CCL project file to compile. This may include the path as well as the complete file name. The function does not assume a particular filename extension such as .ccp or .ccl. This is the path and name of a file on the client, not the server. The client reads the file and sends the text to the server to be compiled.

  • i_output_file: Where to write the compiled ccx program. This should include the path as well as the complete file name. The function does not assume a particular filename extension such as .ccx. You should specify a location at which the c8_client program (or Sybase CEP Studio) can find the file. All relative paths are relative to the current working directory of the process that calls the C8Compile() function. Note that this is the path and name of a file on the client, not the server.

  • i_compiler_flags: The compiler options to use, or NULL for defaults.

  • i_workspac: The workspace name.

  • i_load_name: The load name for the module. This name should be unique within the workspace. For a description of the load name, see the description of the "--name=progname" c8_compiler option in the first table in Compile a Project or a Schema File.

  • i_compiler_uri: The string containing the URI of the compiler service. Since the URI is being compiled on a remote server, this string contains the URI of that remote server in the usual form: http://hostname:port. For example, "http://Mgr1:6789".

  Returns: C8_OK if successful, C8_FAIL otherwise.

• C8Status C8CompileStreamSchema(const C8Char * i_input_file, const C8Char * i_output_file); – Purpose: This function allows you to compile a stream schema file and create a file that contains a Tuple Descriptor.

  Parameters:

  • i_input_file: The name (optionally including the path) of the input file, or schema file. By convention, the filename extension is normally .ccs.

  • i_output_file: The name (optionally including the path) of the output file, or schema file. By convention, the filename extension is normally .ccx.

  Returns: C8_OK if successful, C8_FAIL otherwise.

• C8CompilerOptions * C8CompilerOptionsCreate(); – Purpose: Creates a newly allocated compiler options structure containing default values. The structure must be de-allocated with C8DestroyCompilerOptions().

  Parameters: None.

  Returns: The pointer to the new structure or NULL if the structure could not be allocated.

• void C8CompilerOptionsDestroy(C8CompilerOptions * i_opts); – Purpose: Destroys an instance of the C8CompilerOptions structure.

  Parameters:

  • i_opts: The pointer to a C8CompilerOptions structure.

  Returns: Nothing.

• C8Status C8CompilerOptionsGetRepositoryPath (const C8CompilerOptions * i_opts, const C8Char ** o_res); – Purpose: This gets the path to the SybaseC8Repository.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • o_res: The location to write the result (the repository path) to.

  Returns: C8_OK if successful, C8_FAIL otherwise.

• C8Status C8CompilerOptionsSetRepositoryPath (C8CompilerOptions * i_opts, const C8Char * value); – Purpose: Sets the repository path.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • value: The new path.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetDebugMode(const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: This gets a value that indicates whether the compiler options are set for debug mode.

  Parameters:

  • i_opts: The valid pointer to a compiler option's structure.

  • o_res: The location to write the result to.

  Returns: C8_TRUE if debug mode is set; C8_FALSE otherwise.

• C8Status C8CompilerOptionsSetDebugMode(C8CompilerOptions * i_opts, C8Bool value); – Purpose: This specifies whether to compile in debug mode.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • value: C8_TRUE to set debug mode, C8_FALSE to clear debug mode.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetPlaybackRate (const C8CompilerOptions * i_opts, C8Float * o_res); – Purpose: Gets the accelerated playback rate. For example, 10.0 if the data is accelerated by a factor of 10, or 0.5 if the data is processed at 1/2 the speed indicated by the row timestamps.

  Parameters:

  • i_opts: Is a valid pointer to a compiler options structure.

  • o_res: The location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetPlaybackRate (C8CompilerOptions * i_opts, C8Float value); – Purpose: This function sets the accelerated playback rate. For example, to process the data 10.0 times as fast, set the value to 10.0. To slow the data by a factor of 2, use 0.5.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • value: The new playback rate.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetDeprecationWarningsEnabled (const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: This gets a value that indicates whether deprecation warnings are enabled.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • o_res: The location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetDeprecationWarningsEnabled (C8CompilerOptions * i_opts, C8Bool value); – Purpose: Specifies whether to enable or disable deprecation warnings.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • value: C8_TRUE to enable, C8_FALSE to disable.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetWarnImplicitConversionsEnabled (const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: Gets a value that indicates whether implicit conversion warnings are enabled.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • o_res: The location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetWarnImplicitConversionsEnabled (C8CompilerOptions * i_opts, C8Bool value); – Purpose: This function sets whether to enable or disable implicit conversions options.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • value: C8_TRUE to enable, C8_FALSE to disable.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetFilterAsap (const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: Gets whether the "filter as soon as possible" optimization is enabled.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • o_res: The location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetFilterAsap (C8CompilerOptions * i_opts, C8Bool value); – Purpose: The function specifies whether to enable the "filter as soon as possible" optimization.

  Parameters:

  • i_opts: Valid pointer to a compiler options structure.

  • value: C8_TRUE to enable, C8_FALSE to disable.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetFoldRedundantPrimitives (const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: The function gets whether the optimization to fold redundant primitives is enabled.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • o_res: The location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetFoldRedundantPrimitives (C8CompilerOptions * i_opts, C8Bool value); – Purpose: The function sets whether to enable the optimization to fold redundant primitives.

  Parameters:

  • i_opts: The pointed to a C8CompilerOptions structure.

  • value: C8_TRUE to enable, C8_FALSE to disable.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetIndexWarningsEnabled (const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: The function gets a value that indicates whether the index warnings are enabled.

  Parameters:

  • i_opts: Valid pointer to a compiler options structure.

  • o_res: Location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetIndexWarningsEnabled (C8CompilerOptions * i_opts, C8Bool value); – Purpose: The function sets whether to enable index warnings.

  Parameters:

  • i_opts: Valid pointer to a compiler options structure.

  • value: C8_TRUE to enable, C8_FALSE to disable.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsGetShortcutAndOr (const C8CompilerOptions * i_opts, C8Bool * o_res); – Purpose: The function gets whether "Shortcut And-Or" optimization is enabled.

  Parameters:

  • i_opts: Valid pointer to a compiler options structure.

  • o_res: Location to write the result to.

  Returns: C8_OK on success; C8_Fail otherwise.

• C8Status C8CompilerOptionsSetShortcutAndOr (C8CompilerOptions * i_opts, C8Bool value); – Purpose: The function sets whether to enable "Shortcut And-Or" optimization.

  Parameters:

  • i_opts: Valid pointer to a compiler options structure.

  • value: C8_TRUE to enable, C8_FALSE to disable.

  Returns: C8_OK on success; C8_Fail otherwise.