note
	description: "Path name abstraction"
	library: "Free implementation of ELKS library"
	status: "See notice at end of class."
	legal: "See notice at end of class."
	date: "$Date: 2017-03-23 19:18:26 +0000 (Thu, 23 Mar 2017) $"
	revision: "$Revision: 100033 $"

deferred class interface
	PATH_NAME

feature -- Comparison

	is_equal (other: like Current): BOOLEAN
			-- Is the path name equal to other?
	
feature -- Status report

	is_directory_name_valid (dir_name: STRING_8): BOOLEAN
			-- Is dir_name a valid subdirectory part for the operating system?
		require
			exists: dir_name /= Void

	is_volume_name_valid (vol_name: STRING_8): BOOLEAN
			-- Is vol_name a valid volume name for the operating system?
		require
			exists: vol_name /= Void

	is_valid: BOOLEAN
			-- Is the path name valid for the operating system?
	
feature -- Status setting

	reset (a_name: STRING_8)
			-- Reset content with a path starting with a_name
		require
			a_name_attached: a_name /= Void

	set_volume (volume_name: STRING_8)
			-- Set the volume part of the path name to volume_name.
		require
			string_exists: volume_name /= Void
			valid_volume_name: is_volume_name_valid (volume_name)
			empty_path_name: is_empty
		ensure
			valid_file_name: is_valid

	extend (directory_name: STRING_8)
			-- Append the subdirectory directory_name to the path name.
			-- Was declared in PATH_NAME as synonym of set_subdirectory.
		require
			string_exists: directory_name /= Void
			valid_directory_name: is_directory_name_valid (directory_name)
		ensure
			valid_file_name: is_valid

	set_subdirectory (directory_name: STRING_8)
			-- Append the subdirectory directory_name to the path name.
			-- Was declared in PATH_NAME as synonym of extend.
		require
			string_exists: directory_name /= Void
			valid_directory_name: is_directory_name_valid (directory_name)
		ensure
			valid_file_name: is_valid

	set_directory (directory_name: STRING_8)
			-- Set the absolute directory part of the path name to directory_name.
		require
			string_exists: directory_name /= Void
			valid_directory_name: is_directory_name_valid (directory_name)
		ensure
			valid_file_name: is_valid

	extend_from_array (directories: ARRAY [STRING_8])
			-- Append the subdirectories from directories to the path name.
		require
			array_exists: directories /= Void and then not directories.is_empty
		ensure
			valid_file_name: is_valid
	
note
	copyright: "Copyright (c) 1984-2017, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		5949 Hollister Ave., Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class PATH_NAME

Generated by ISE EiffelStudio