INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

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

compiler_name: STRING
-- Returns compiler name

compiler_version: STRING
-- Returns compiler version

bin_folder: STRING
-- Path of "BIN" folder where the components of the compiler should be
-- located
feature -- Operations on repository

close_repository
-- Close the repository (this)

erase_repository
-- Remove all elements from the repository

cure_repository
-- Remove all broken elements from the repository
feature -- Access: Clusters

repository_clusters: ARRAY [STRING]
-- List all clusters in the repository
-- Retruns Void if there are no clusters at all

add_cluster_to_repository (name: STRING; path: STRING): BOOLEAN
-- Adds the cluster with the name and path given to the repository
-- Returns True iff the operation succedes
require
non_void_name: name /= void
non_void_path: path /= void

parse_cluster (name: STRING): BOOLEAN
-- Parse the cluster specified
-- Returns True iff the operation succedes
require
non_void_name: name /= void

import_cluster (name, path: STRING): BOOLEAN
-- Imports the cluster specified into the repopsitory
-- Returns True iff the operation succedes
require
non_void_name: name /= void
non_void_path: path /= void

mount_cluster (name, path: STRING): BOOLEAN
-- Mounts the cluster specified to the repopsitory
-- Returns True iff the operation succedes
require
non_void_name: name /= void
non_void_path: path /= void

remove_cluster_from_repository (name: STRING): BOOLEAN
-- Deletes the cluster specified from the repopsitory
-- Returns True iff the operation succedes
require
non_void_name: name /= void

export_cluster (name: STRING): BOOLEAN
-- Exports the cluster specified from the repopsitory
-- Returns True iff the operation succedes
require
non_void_name: name /= void

unmount_cluster (name: STRING): BOOLEAN
-- Unmounts the cluster specified from the repopsitory
-- Returns True iff the operation succedes
require
non_void_name: name /= void

cluster_classes (name: STRING; used_in_project: BOOLEAN): ARRAY [STRING]
-- Returns list of all classes in the cluster given
-- The list contains only classes in the current project if
-- used_in_project=True
require
non_void_name: name /= void

clusters_with_class (name: STRING): ARRAY [STRING]
-- Returns list of clusters which contain the class "class_name"
-- Returns Void if there are no such clusters
require
non_void_name: name /= void

cluster_path (name: STRING): STRING
-- Returns path where the cluster given is located
require
non_void_name: name /= void
feature -- Access: Libraries

repository_libraries: ARRAY [STRING]
-- List all libraries in the repository
-- Retruns Void if there are no libraries at all

open_library (name: STRING): BOOLEAN
-- Opens the library specified
-- Returns True iff the operation succedes
require
non_void_name: name /= void

close_library
-- Closes the library having been opened

create_new_library (name, path: STRING): BOOLEAN
-- Creates new library with the given name at the given path
require
non_void_name: name /= void
non_void_path: path /= void

create_new_library_from_template (template_name: STRING): STRING
-- Creates new library using the template specified
-- Returns the name of the library been created or Void if the
-- operation fails
require
non_void_template_name: template_name /= void

remove_library (name: STRING): BOOLEAN
-- Removes the library specified
-- Returns True iff the operation succedes
require
non_void_name: name /= void

library_clusters: ARRAY [STRING]
-- Returns list of all clusters which belong to the library

library_classes: ARRAY [STRING]
-- Returns list of all classes which belong to the library
feature -- Access: Projects

repository_projects: ARRAY [STRING]
-- Returns list of all projects in the repopsitory
-- Returns Void if there are no projects at all

open_project (name: STRING): BOOLEAN
-- Opens the library specified
-- Returns True iff the operation succedes
require
non_void_name: name /= void

close_project
-- Closes the project having been opened

create_project (name, path, exe_name, root, creator: STRING): BOOLEAN
-- Creates new project
-- Arguments:
-- name - name of the project
-- path - path to project directory
-- exe_name - name of the executable
-- root - name of root class
-- creator - name of creation procedure
-- Returns True iff the operation succedes
require
non_void_name: name /= void
non_void_path: path /= void
non_void_exe_name: exe_name /= void
non_void_root: root /= void
non_void_creator: creator /= void

create_project_from_template (template_name: STRING): STRING
-- Creates new project from template
-- Returns the name of the project if the operation succedes or
-- Void otherwise
require
non_void_template_name: template_name /= void

remove_project (name: STRING): BOOLEAN
-- Removes the project specified
require
non_void_name: name /= void

project_clusters: ARRAY [STRING]
-- Returns the list of clusters which belong to the project
-- Returns Void if there are no such clusters

project_classes: ARRAY [STRING]
-- Returns the list of classes which belong to the project
-- Returns Void if there are no such clusters

root_class: STRING
-- Returns the name of the root class
-- Returns Void if the operation fails

creation_procedure: STRING
-- Returns the name of the creation procedure of the root class
-- Returns Void if the operation fails

executable_path: STRING
-- Returns full path of the target executable module (exe or dll)
-- Returns Void if the operation fails
feature -- Access: Classes

all_features (class_name: STRING): ARRAY [STRING]
-- Returns list of all features (own & inherited) of the class
-- Returns Void if there are no features at all
require
non_void_class_name: class_name /= void

own_features (class_name: STRING): ARRAY [STRING]
-- Returns list of own features of the class
-- Returns Void if there are no such features at all
require
non_void_class_name: class_name /= void

inherited_features (class_name: STRING): ARRAY [STRING]
-- Returns list of inherited features of the class
-- Returns Void if there are no such features at all
require
non_void_class_name: class_name /= void

creators (class_name: STRING): ARRAY [STRING]
-- Returns list of creation routines of the class
-- Returns Void if there are creation routines at all
require
non_void_class_name: class_name /= void

ancestors (class_name: STRING): ARRAY [STRING]
-- Returns list of ancestors of the class
-- Returns Void if the class does not have ancestors
require
non_void_class_name: class_name /= void

descendants (class_name: STRING): ARRAY [STRING]
-- Returns list of descendants of the class
-- Returns Void if the class does not have descendants
require
non_void_class_name: class_name /= void

suppliers (class_name: STRING): ARRAY [STRING]
-- Returns list of suppliers of the class
-- Returns Void if the class does not have suppliers
require
non_void_class_name: class_name /= void

clients (class_name: STRING): ARRAY [STRING]
-- Returns list of descendants of the class
-- Returns Void if the class does not have descendants
require
non_void_class_name: class_name /= void

source_file (class_name: STRING): STRING
-- Returns full path of the class source
-- Returns Void if the operation fails
require
non_void_class_name: class_name /= void

short_form (class_name: STRING): ARRAY [STRING]
-- Returns short form of the class
-- Returns Void if the operation fails
require
non_void_class_name: class_name /= void

flat_form (class_name: STRING): ARRAY [STRING]
-- Returns short form of the class
-- Returns Void if the operation fails
require
non_void_class_name: class_name /= void
feature -- Actions: Compilation

assemble_project: BOOLEAN
-- Assembles the project
-- Returns True if the operation succedes

rebuild_project: BOOLEAN
-- Rebuilds the project from the scratch
-- Returns True if the operation succedes

assemble_library: BOOLEAN
-- Assembles the library
-- Returns True if the operation succedes
feature -- Access: Messages

messages: ARRAY [VE_API_MESSAGE]
end -- class VISUAL_EIFFEL_API

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES