Replaceable User Files - Revision history

Manus at 12:19, 21 January 2016

2016-01-21T12:19:27Z

Manus: Use new code.

2011-11-08T23:48:19Z

Use new code.

Manus: Updated to the new path for the user files that can be overridden.

2011-11-08T23:44:16Z

Updated to the new path for the user files that can be overridden.

Manus: Fixed wrong environment variable name

2011-11-08T23:38:42Z

Fixed wrong environment variable name

Paulb: Updated to use attached syntax

2009-08-11T16:58:45Z

Updated to use attached syntax

Jfiat: /* User Files */

2008-09-26T08:12:00Z

‎User Files

Jfiat: /* User Files */

2008-09-26T08:11:45Z

‎User Files

Jfiat: /* User Files */

2008-09-26T08:11:25Z

‎User Files

Jfiat: /* User Files */

2008-09-26T07:06:23Z

‎User Files

Paulb: /* User Files */

2008-07-31T21:52:04Z

‎User Files

@@ Line 1: / Line 1: @@
 [[Category:Extending EiffelStudio]]
 [[Category:EiffelStudio]]
 With the release of [[:Category:EiffelStudio|EiffelStudio]] [[EiffelStudio 6.2 Releases|6.2]] came the notion of user files, or user replaceable files. These are configuration files, and the like, the end-user (that's you) can author to override a matching file found in the stock [[:Category:EiffelStudio|EiffelStudio]] installation.

@@ Line 45: / Line 45: @@
 <e>
 compiler_configuration: FILE_NAME
-    -- Platform specific system level resource specification file.
+		-- Platform specific system level resource specification file
-  require
+		-- ($ISE_EIFFEL/eifinit/application_name/spec/$ISE_PLATFORM)
-    is_valid_environment: is_valid_environment
+	require
-  once
+		is_valid_environment: is_valid_environment
-    create Result.make_from_string (eifinit_path)
+	once
-    Result.set_file_name ("general")
+		create Result.make_from_string (eifinit_path)
-    Result.add_extension ("cfg")
+		Result.set_file_name ("general")
+		Result.add_extension ("cfg")
-    if is_user_files_supported then
+		if is_user_files_supported then
-        -- Check user override file.
+				-- Check user override file.
-      if attached user_priority_file_name (Result, True) as l_user_fn then
+			if attached user_priority_file_name (Result, True) as l_user then
-        Result := l_user_fn
+				Result := l_user
-      end
+			end
-    end
+		end
-  ensure
+	ensure
-    not_result_is_empty: not Result.is_empty
+		not_result_is_empty: not Result.is_empty
-  end
+	end
 </e>

@@ Line 11: / Line 11: @@
 User files and folders can replace or augment files found under the installation under ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio''. The following indicates the corresponding user paths to place installation user replacement/augment files (''X.X'' indicates the ''Major.Minor'' version number of the compiler):
-* Under '''Windows''' the default location for Eiffel user files is ''%HOMEDRIVE%\%HOMEPATH%\My Documents\Eiffel X.X User Files\studio''
+* Under '''Windows''' the default location for Eiffel user files is ''%HOMEDRIVE%\%HOMEPATH%\My Documents\Eiffel User Files\X.X\studio''
-* Under '''Unix/Linux''' the default location is ''~/.esXX/studio''
+* Under '''Unix/Linux''' the default location is ''~/.es/Eiffel User Files/X.X/studio''
-* Under '''Mac OS X''' the default location is ''~/Eiffel X.X User Files/studio''
+* Under '''Mac OS X''' the default location is ''~/Eiffel User Files/X.X/studio''
 If any of these location do not suit your needs, set the environment variable [[Environment Variables#Optional Variables|ISE_USER_FILES]] to point to the user files folder. Defining [[Environment Variables#Optional Variables|ISE_USER_FILES]] means user replacement/augmented files will be located under [[Environment Variables#Optional Variables|$ISE_USER_FILES]]/studio.
@@ Line 21: / Line 21: @@
 To replace an install file with a user file simply mirror the directory structure found under ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio'' in the user files folder, as explained above. Create or place a file with the same name in the user files respective folder and it will be utilized instead of the stock installed edition. It's that simple!
-{{Note|If running a workbench version of [[:Category:EiffelStudio|EiffelStudio]] or the Eiffel compiler remember to place user files under the user file folder with a '' (workbench)'' suffix for Windows, and ''_wkbench" suffix for non Windows. <br/>I.E. Under Linux place user files under ''~/.esXX_wkbench/studio'' instead of ''~/.esXX/studio''.<br/> If the [[Environment Variables#Optional Variables|$ISE_APP_DATA]] environment variable has been defined then the ''_wkbench'' suffix is not used because of the explicit use of an overriding the default value with an [[Environment Variables|environment variable]].}}
+{{Note|If running a workbench version of [[:Category:EiffelStudio|EiffelStudio]] or the Eiffel compiler remember to place user files under the user file folder with a '' (workbench)'' suffix for Windows, and ''_workbench" suffix for non Windows. <br/>I.E. Under Linux place user files under ''~/.es_workbench/Eiffel User Files/X.X/studio'' instead of ''~/.es/Eiffel User Files/X.X/studio''.<br/> If the [[Environment Variables#Optional Variables|$ISE_USER_FILES]] environment variable has been defined then the suffix is not used because of the explicit use of an overriding the default value with an [[Environment Variables|environment variable]].}}
 === User Folders ===

@@ Line 17: / Line 17: @@
 * Under '''Mac OS X''' the default location is ''~/Eiffel X.X User Files/studio''
-If any of these location do not suit your needs, set the environment variable [[Environment Variables#Optional Variables|ISE_APP_DATA]] to point to the root user files folder. Defining [[Environment Variables#Optional Variables|ISE_APP_DATA]] means user replacement/augmented files will be located under [[Environment Variables#Optional Variables|$ISE_APP_DATA]]/studio.
+If any of these location do not suit your needs, set the environment variable [[Environment Variables#Optional Variables|ISE_USER_FILES]] to point to the user files folder. Defining [[Environment Variables#Optional Variables|ISE_USER_FILES]] means user replacement/augmented files will be located under [[Environment Variables#Optional Variables|$ISE_USER_FILES]]/studio.
 To replace an install file with a user file simply mirror the directory structure found under ''[[Environment Variables#Core Variables|$ISE_EIFFEL]]/studio'' in the user files folder, as explained above. Create or place a file with the same name in the user files respective folder and it will be utilized instead of the stock installed edition. It's that simple!

@@ Line 44: / Line 44: @@
 Here's an example of utilizing user files as found in <e>EIFFEL_ENV</e>:
 <e>
-compiler_configuration: !FILE_NAME
+compiler_configuration: FILE_NAME
      -- Platform specific system level resource specification file.
    require
@@ Line 55: / Line 55: @@
      if is_user_files_supported then
          -- Check user override file.
-       if {l_user: like user_priority_file_name} user_priority_file_name (Result, True) then
+       if attached user_priority_file_name (Result, True) as l_user_fn then
-         Result := l_user
+         Result := l_user_fn
        end
      end