INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "Visual Eiffel OOCAPI client"
project: "Visual Eiffel"
revision: "$Revision: 1.3 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: visual_eiffel_api
class OOCAPI
inherit

DLL_SERVER
end
feature -- General

destroy
-- Shutdown OOCAPI

check_environment: BOOLEAN
-- If environment is not set you cannot work with OOCAPI

get_compiler_version: INTEGER
-- returns compiler version as DWORD
-- major version number returned in HIWORD (Result // 65536)
-- minor version number returned in LOWORD (Result \\ 65536)
-- Result := version_hi * 65536 + version_lo

get_compiler_name: STRING
-- returns compiler name

ve_bin: STRING
-- Visual Eiffel $VE_Bin directory

ve_lib: STRING
-- Visual Eiffel $VE_Bin directory

ve_data: STRING
-- Visual Eiffel $VE_Data directory
feature -- Universe Actions

open_universe: BOOLEAN
-- To work with OOCAPI you must open universe.

close_universe
-- Close universe.

erase_universe

cure_universe
feature -- Universe Clusters

get_universe_clusters: ARRAY [INTEGER]
-- Returns array of ID's of universe clusters.

get_cluster_name (cluster_id: INTEGER): STRING
-- returns name of the cluster

get_cluster_id (cluster_name: STRING): INTEGER

add_cluster_to_universe (cluster_name, cluster_path: STRING): INTEGER

parse_cluster (cluster_id: INTEGER): BOOLEAN

import_cluster_to_universe (cluster_name, cluster_path: STRING): BOOLEAN

mount_cluster_to_universe (cluster_name, cluster_path: STRING): BOOLEAN

remove_cluster_from_universe (cluster_id: INTEGER): BOOLEAN

export_cluster_from_universe (cluster_id: INTEGER): BOOLEAN

unmount_cluster_from_universe (cluster_id: INTEGER): BOOLEAN

get_cluster_classes (cluster_id: INTEGER; used_in_project: BOOLEAN): ARRAY [INTEGER]
-- Returns array of ID's of cluster classes  [*]

get_clusters_with_class (class_name: STRING): ARRAY [INTEGER]
-- Returns array of cluster id's where the class "class_name" exists.

get_cluster_path (id: INTEGER): STRING
feature -- Library information

get_universe_libraries: ARRAY [INTEGER]
-- Returns array of ID's of universe libraries.

get_library_name (library_id: INTEGER): STRING
-- Returns library name

get_library_id (library_name: STRING): INTEGER

open_library (library_id: INTEGER): BOOLEAN

close_library

create_new_library (name, path: STRING): INTEGER
-- Returns library_id of new library or zero
-- arguments:
-- name - name of the library
-- path - path to library directory
require
path /= void

create_new_library_from_template (template_name: STRING): INTEGER
require
template_name /= void

remove_library (library: INTEGER): BOOLEAN

get_library_clusters: ARRAY [INTEGER]
-- Returns array of ID's of library clusters.

get_library_classes: ARRAY [INTEGER]
-- Returns array of ID's of library classes.
feature -- Project information

get_universe_projects: ARRAY [INTEGER]
-- Returns array of ID's of universe projects.

get_project_name (project_id: INTEGER): STRING

get_project_id (project_name: STRING): INTEGER

get_project_file_name: STRING
-- Get the name of the currently open project file

open_project (project_id: INTEGER): BOOLEAN

close_project

create_new_project (name, path, exe_name, root, creator: STRING): INTEGER
-- Returns project_id of new project or zero
-- arguments:
-- name - name of the project
-- path - path to project directory
-- root - name of root class
-- creator - name of creation procedure.
require
name /= void and then path /= void and then root /= void

create_new_project_from_template (template_name: STRING): INTEGER
require
template_name /= void

remove_project (project: INTEGER): BOOLEAN
-- removes project.

get_project_clusters: ARRAY [INTEGER]
-- Returns array of ID's of project clusters.

get_project_classes: ARRAY [INTEGER]
-- Returns array of ID's of project classes.

get_root_class: INTEGER
-- Returns root class ID.

get_creation_procedure: INTEGER
-- Returns root class creation procedure ID.

get_project_executable_path: STRING
-- Returns full-path filename of the target executable module (exe or dll)

is_project_source (file_name: STRING): BOOLEAN
feature -- Classes information

get_class_name (class_id: INTEGER): STRING

get_class_id (class_name: STRING; cluster_id: INTEGER): INTEGER

get_cluster_for_class (class_id: INTEGER): INTEGER

all_features (class_id: INTEGER): ARRAY [INTEGER]
-- returns array of id's of all features (own & inherited)

own_features (class_id: INTEGER): ARRAY [INTEGER]

inherited_features (class_id: INTEGER): ARRAY [INTEGER]

ancestors (class_id: INTEGER): ARRAY [INTEGER]

descendants (class_id: INTEGER): ARRAY [INTEGER]

suppliers (class_id: INTEGER): ARRAY [INTEGER]

clients (class_id: INTEGER): ARRAY [INTEGER]

get_creators (class_id: INTEGER): ARRAY [INTEGER]
-- Using these ID's you can obtain name and clients for each creation
-- procedure (use: get_creator_clients, get_creator_name).

get_indexing (class_id: INTEGER): ARRAY [INTEGER]
-- Using these ID's you can obtain tag and index elements for each
-- indexing string (use: get_index_tag, get_index_elements).

get_invariant (class_id: INTEGER): ARRAY [INTEGER]
-- Using these ID's you can obtain tag and value for each
-- string of class invariant assertion
-- (use: get_assertion_tag, get_assertion_value).

class_file (class_id: INTEGER): STRING
-- returns full-path filename of the class source

get_class_obsolete (class_id: INTEGER): STRING

is_deferred (class_id: INTEGER): BOOLEAN

is_expanded (class_id: INTEGER): BOOLEAN

is_instantination (class_id: INTEGER): BOOLEAN

get_template (class_id: INTEGER): INTEGER

get_formal_generic_list (class_id: INTEGER): ARRAY [INTEGER]
-- (See also: get_fg_name, get_fg_constraint).

short_form (class_id: INTEGER): ARRAY [STRING]

flat_form (class_id: INTEGER): ARRAY [STRING]

get_instanses (class_id: INTEGER): ARRAY [INTEGER]

oocapi_get_instances (class_id: INTEGER)
feature -- Feature information

get_feature_name (class_id, feature_id: INTEGER): STRING

get_feature_id (feature_name: STRING; class_id: INTEGER): INTEGER

is_attribute (class_id, feature_id: INTEGER): BOOLEAN

is_constant (class_id, feature_id: INTEGER): BOOLEAN

get_attribute_offset (class_id, feature_id: INTEGER): INTEGER

feature_short (class_id, feature_id: INTEGER): ARRAY [STRING]

get_locals (class_id, feature_id: INTEGER): ARRAY [INTEGER]
-- Using these id's you can obtain name and type for each
-- local's entity (See also: get_entity_name, get_entity_type).

get_arguments (class_id, feature_id: INTEGER): ARRAY [INTEGER]
-- Using these id's you can obtain name and type for each
-- argument's entity (See also: get_entity_name, get_entity_type).

get_feature_type (class_id, feature_id: INTEGER): INTEGER
-- Returns ID of feature type (0 for procedures)

get_constant_value (class_id, feature_id: INTEGER): STRING
-- Returns constant value as STRING

get_require (class_id, feature_id: INTEGER): ARRAY [INTEGER]
-- Returns array of require assertions IDs
-- (See also: get_assertion_tag, get_assertion_value)

get_ensure (class_id, feature_id: INTEGER): ARRAY [INTEGER]
-- Returns array of ensure assertions IDs
-- (See also: get_assertion_tag, get_assertion_value)

get_routine_comment (class_id, feature_id: INTEGER): ARRAY [STRING]
-- returns feature_comment (first comment after feature name)

get_routine_obsolete (class_id, feature_id: INTEGER): STRING
-- Returns index of obsolete string of the feature.

get_feature_clients (class_id, feature_id: INTEGER): ARRAY [INTEGER]
-- Returns array of feature clients (export status of the feature)
-- (clients represented as class names)

get_feature_origin (class_id, feature_id: INTEGER): INTEGER
feature -- Indexing information

get_index_tag (class_id, index_id: INTEGER): STRING

get_index_elements (class_id, index_id: INTEGER): ARRAY [STRING]
feature -- Creators information

get_creator_clients (class_id, creator_id: INTEGER): ARRAY [STRING]
-- Returns array of class names representing export status of the
-- creation procedure
feature -- Formal Generic information

get_fg_name (class_id, fg_id: INTEGER): STRING

get_fg_constraint (class_id, fg_id: INTEGER): STRING
-- returns name of formal generic constraint
feature -- Assertions information

get_assertion_tag (class_id, feature_id, assertion_id: INTEGER): STRING
-- returns tag of assertion for the feature "feature_id"
-- if feature_id = 0 then returns class invariant tag.
-- (tag is represented as string)
-- if there is no tag in the assertion "assertion_id" then
-- Result = Void.

get_assertion_value (class_id, feature_id, assertion: INTEGER): STRING
-- returns value of the assertion for the feature "feature_id"
-- if feature_id = 0 then returns class invariant value
-- (assertion value is represented as string)
feature -- Entities information

get_entity_name (class_id, feature_id, entity_id: INTEGER): STRING
-- returns name of the entity (name of local or argument)

get_entity_type (class_id, feature_id, entity_id: INTEGER): INTEGER
-- returns ID of type of the entity (name of local or argument)

get_entity_id (class_id, feature_id: INTEGER; entity_name: STRING): INTEGER

get_entity_offset (class_id, feature_id, entity_id: INTEGER): INTEGER
feature -- Compiler Actions

assemble_project: BOOLEAN

rebuild_project: BOOLEAN

finalize_project: BOOLEAN

assemble_library: BOOLEAN

parse_file (file: STRING): BOOLEAN
feature -- Compiler Messages

get_compilation_status: BOOLEAN
-- Returns true if last compilation successfull

get_messages: ARRAY [INTEGER]
-- Call this feature to obtain error diagnostics from compiler

get_message_sender (message_id: INTEGER): STRING
-- returns 'sender' of the message (e.g. "Compiler", "Linker" etc)

get_message_status (message_id: INTEGER): STRING
-- returns 'status' of the message (e.g. "Error", "Warning" etc)

get_message_class (message_id: INTEGER): STRING
-- Returns class corresponding to the message

get_message_source_file (message_id: INTEGER): STRING
-- returns source file corresponding to the message

get_message_line (message_id: INTEGER): INTEGER

get_message_pos (message_id: INTEGER): INTEGER

get_message_text (message_id: INTEGER): ARRAY [STRING]
-- Returns text explanation for the massage

get_message_string (message_id: INTEGER): STRING

get_message_code_string (message_id: INTEGER): STRING

clear_messages
-- Clears OOCAPI internal message buffer
feature -- Project options

string_type: INTEGER

constraint_string_type: INTEGER

integer_type: INTEGER

boolean_type: INTEGER

separator_type: INTEGER

get_project_options_count: INTEGER

get_project_option_name (option_id: INTEGER): STRING

get_project_option_type (option_id: INTEGER): INTEGER

get_string_project_option_value (option_id: INTEGER): STRING

get_string_project_option_constraint (option_id: INTEGER): ARRAY [STRING]

get_integer_project_option_value (option_id: INTEGER): INTEGER

set_string_project_option_value (option_id: INTEGER; val: STRING)

set_integer_project_option_value (option_id: INTEGER; val: INTEGER)

set_new_project_target (new_target: STRING): BOOLEAN

set_new_root (new_root: STRING): BOOLEAN

set_new_creation (new_creation: STRING): BOOLEAN

add_cluster_to_project (cluster_id: INTEGER): BOOLEAN

remove_cluster_from_project (cluster_id: INTEGER): BOOLEAN

set_warning_level (lev: INTEGER)
feature -- Library settings

get_library_options_count: INTEGER

get_library_option_name (option_id: INTEGER): STRING

get_library_option_type (option_id: INTEGER): INTEGER

get_string_library_option_value (option_id: INTEGER): STRING

get_string_library_option_constraint (option_id: INTEGER): ARRAY [STRING]

get_integer_library_option_value (option_id: INTEGER): INTEGER

set_string_library_option_value (option_id: INTEGER; val: STRING)

set_integer_library_option_value (option_id: INTEGER; val: INTEGER)

add_cluster_to_library (cluster_id: INTEGER): BOOLEAN

remove_cluster_from_library (cluster_id: INTEGER): BOOLEAN
end -- class OOCAPI

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES