dirfns.cc File Reference

#include <cerrno>
#include <cstdio>
#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <sstream>
#include <string>
#include <sys/types.h>
#include <unistd.h>
#include "file-ops.h"
#include "file-stat.h"
#include "glob-match.h"
#include "oct-env.h"
#include "pathsearch.h"
#include "str-vec.h"
#include "Cell.h"
#include "defun.h"
#include "dir-ops.h"
#include "dirfns.h"
#include "error.h"
#include "gripes.h"
#include "input.h"
#include "load-path.h"
#include "oct-obj.h"
#include "pager.h"
#include "procstream.h"
#include "sysdep.h"
#include "toplev.h"
#include "unwind-prot.h"
#include "utils.h"
#include "variables.h"

Include dependency graph for dirfns.cc:

Go to the source code of this file.

Functions
	DEFALIAS (chdir, cd)
	DEFUN (pwd,,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} pwd ()\n\ Return the current working directory.\n\ @seealso{dir, ls}\n\ @end deftypefn")
	DEFUN (pathsep, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\ Query or set the character used to separate directories in a path.\n\ @seealso{filesep}\n\ @end deftypefn")
	DEFUN (confirm_recursive_rmdir, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})\n\ @deftypefnx {Built-in Function} {} confirm_recursive_rmdir (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether Octave\n\ will ask for confirmation before recursively removing a directory tree.\n\ \n\ When called from inside a function with the \"local\" option, the variable is\n\ changed locally for the function and any subroutines it calls. The original\n\ variable value is restored when exiting the function.\n\ @end deftypefn")
	DEFUN (readdir, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{files}, @var{err}, @var{msg}] =} readdir (@var{dir})\n\ Return names of the files in the directory @var{dir} as a cell array of\n\ strings. If an error occurs, return an empty cell array in @var{files}.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{ls, dir, glob}\n\ @end deftypefn")
	DEFUN (cd, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Command} {} cd dir\n\ @deftypefnx {Command} {} chdir dir\n\ Change the current working directory to @var{dir}. If @var{dir} is\n\ omitted, the current directory is changed to the user's home\n\ directory. For example,\n\ \n\ @example\n\ cd ~/octave\n\ @end example\n\ \n\ @noindent\n\ changes the current working directory to @file{~/octave}. If the\n\ directory does not exist, an error message is printed and the working\n\ directory is not changed.\n\ @seealso{mkdir, rmdir, dir}\n\ @end deftypefn")
	DEFUN (glob, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} glob (@var{pattern})\n\ Given an array of pattern strings (as a char array or a cell array) in\n\ @var{pattern}, return a cell array of file names that match any of\n\ them, or an empty cell array if no patterns match. The pattern strings are\n\ interpreted as filename globbing patterns (as they are used by Unix shells).\n\ Within a pattern\n\ @table @code\n\ @itemx *\n\ matches any string, including the null string,\n\ @itemx ?\n\ matches any single character, and\n\ \n\ @item [@dots{}]\n\ matches any of the enclosed characters.\n\ @end table\n\ \n\ Tilde expansion\n\ is performed on each of the patterns before looking for matching file\n\ names. For example:\n\ \n\ @example\n\ ls\n\ @result{}\n\ file1 file2 file3 myfile1 myfile1b\n\ glob (\"*file1\")\n\ @result{}\n\ @{\n\ [1,1] = file1\n\ [2,1] = myfile1\n\ @}\n\ glob (\"myfile?\")\n\ @result{}\n\ @{\n\ [1,1] = myfile1\n\ @}\n\ glob (\"file[12]\")\n\ @result{}\n\ @{\n\ [1,1] = file1\n\ [2,1] = file2\n\ @}\n\ @end example\n\ @seealso{ls, dir, readdir}\n\ @end deftypefn")
	DEFUN (filesep, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} filesep ()\n\ @deftypefnx {Built-in Function} {} filesep ('all')\n\ Return the system-dependent character used to separate directory names.\n\ \n\ If 'all' is given, the function returns all valid file separators in\n\ the form of a string. The list of file separators is system-dependent.\n\ It is @samp{/} (forward slash) under UNIX or @w{Mac OS X}, @samp{/} and\n\ @samp{\\} (forward and backward slashes) under Windows.\n\ @seealso{pathsep}\n\ @end deftypefn")
	DEFUNX ("symlink", Fsymlink, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} symlink (@var{old}, @var{new})\n\ Create a symbolic link @var{new} which contains the string @var{old}.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{link, readlink}\n\ @end deftypefn")
	DEFUNX ("fnmatch", Ffnmatch, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\ Return 1 or zero for each element of @var{string} that matches any of\n\ the elements of the string array @var{pattern}, using the rules of\n\ filename pattern matching. For example:\n\ \n\ @example\n\ @group\n\ fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\ @result{} [ 1; 1; 0 ]\n\ @end group\n\ @end example\n\ @end deftypefn")
	DEFUNX ("rename", Frename, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} rename (@var{old}, @var{new})\n\ Change the name of file @var{old} to @var{new}.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{ls, dir}\n\ @end deftypefn")
	DEFUNX ("mkdir", Fmkdir, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{dir})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{parent}, @var{dir})\n\ Create a directory named @var{dir} in the directory @var{parent}.\n\ \n\ If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ system-dependent error message, and @var{msgid} contains a unique\n\ message identifier.\n\ @seealso{rmdir}\n\ @end deftypefn")
	DEFUNX ("rmdir", Frmdir, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir}, \"s\")\n\ Remove the directory named @var{dir}.\n\ \n\ If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ system-dependent error message, and @var{msgid} contains a unique\n\ message identifier.\n\ \n\ If the optional second parameter is supplied with value @code{\"s\"},\n\ recursively remove all subdirectories as well.\n\ @seealso{mkdir, confirm_recursive_rmdir}\n\ @end deftypefn")
	DEFUNX ("link", Flink, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} link (@var{old}, @var{new})\n\ Create a new link (also known as a hard link) to an existing file.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{symlink}\n\ @end deftypefn")
	DEFUNX ("readlink", Freadlink, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{result}, @var{err}, @var{msg}] =} readlink (@var{symlink})\n\ Read the value of the symbolic link @var{symlink}.\n\ \n\ If successful, @var{result} contains the contents of the symbolic link\n\ @var{symlink}, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{link, symlink}\n\ @end deftypefn")
static int	octave_change_to_directory (const std::string &newdir)
Variables
static bool	Vconfirm_recursive_rmdir = true
octave_time	Vlast_chdir_time = 0.0

---

Function Documentation

DEFALIAS	(	chdir	,
		cd
	)

DEFUN

(

pwd

)

Definition at line 149 of file dirfns.cc.

References octave_env::get_current_directory(), and octave_value().

DEFUN	(	pathsep	,
		args	,
		nargout
	)

Definition at line 724 of file dirfns.cc.

References error(), error_state, dir_path::path_sep_char(), dir_path::path_sep_str(), and print_usage().

DEFUN	(	confirm_recursive_rmdir	,
		args	,
		nargout
	)

Definition at line 769 of file dirfns.cc.

References SET_INTERNAL_VARIABLE.

DEFUN	(	readdir	,
		args
	)

Definition at line 159 of file dirfns.cc.

References dir_entry::error(), error_state, gripe_wrong_type_arg(), print_usage(), dir_entry::read(), and string_vector::sort().

DEFUN	(	cd	,
		args	,
		nargout
	)

Definition at line 90 of file dirfns.cc.

References error_state, octave_env::get_current_directory(), octave_env::get_home_directory(), octave_change_to_directory(), and octave_value().

DEFUN	(	glob	,
		args
	)

Definition at line 549 of file dirfns.cc.

References error_state, glob_match::glob(), gripe_wrong_type_arg(), print_usage(), and file_ops::tilde_expand().

DEFUN	(	filesep	,
		args
	)

Definition at line 687 of file dirfns.cc.

References file_ops::dir_sep_chars(), file_ops::dir_sep_str(), error_state, gripe_wrong_type_arg(), and print_usage().

DEFUNX	(	"symlink"	,
		Fsymlink	,
		args
	)

Definition at line 412 of file dirfns.cc.

References error_state, gripe_wrong_type_arg(), octave_symlink(), and print_usage().

DEFUNX	(	"fnmatch"	,
		Ffnmatch	,
		args
	)

Definition at line 650 of file dirfns.cc.

References error_state, gripe_wrong_type_arg(), glob_match::match(), print_usage(), and file_ops::tilde_expand().

DEFUNX	(	"rename"	,
		Frename	,
		args
	)

Definition at line 502 of file dirfns.cc.

References error_state, gripe_wrong_type_arg(), octave_rename(), and print_usage().

DEFUNX	(	"mkdir"	,
		Fmkdir	,
		args
	)

Definition at line 208 of file dirfns.cc.

References file_ops::concat(), error_state, gripe_wrong_type_arg(), base_file_stat::is_dir(), octave_value_list::length(), octave_mkdir(), print_usage(), and file_ops::tilde_expand().

DEFUNX	(	"rmdir"	,
		Frmdir	,
		args
	)

Definition at line 291 of file dirfns.cc.

References error(), error_state, gripe_wrong_type_arg(), interactive, octave_value_list::length(), octave_recursive_rmdir(), octave_rmdir(), octave_yes_or_no(), print_usage(), and file_ops::tilde_expand().

DEFUNX	(	"link"	,
		Flink	,
		args
	)

Definition at line 365 of file dirfns.cc.

References error_state, gripe_wrong_type_arg(), octave_link(), and print_usage().

DEFUNX	(	"readlink"	,
		Freadlink	,
		args
	)

Definition at line 459 of file dirfns.cc.

References error_state, gripe_wrong_type_arg(), octave_readlink(), and print_usage().

static int octave_change_to_directory

(

const std::string &

newdir

)

[static]

Definition at line 71 of file dirfns.cc.

References octave_env::chdir(), error(), octave_time::stamp(), file_ops::tilde_expand(), and load_path::update().

Referenced by DEFUN().

---

Variable Documentation

bool Vconfirm_recursive_rmdir = true [static]

Definition at line 65 of file dirfns.cc.

octave_time Vlast_chdir_time = 0.0

Definition at line 68 of file dirfns.cc.

Referenced by out_of_date_check().