octave: liboctave/util/pathsearch.h annotate

annotate liboctave/util/pathsearch.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	1 /*
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	2
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 1996-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	7
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	8
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23743 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23743 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 (at your option) any later version.
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	20
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	21 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6108 diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23743 diff changeset	23 <https://www.gnu.org/licenses/>.
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	24
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	25 */
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	27 #if ! defined (octave_pathsearch_h)
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	28 #define octave_pathsearch_h 1
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	31
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	32 #include <list>
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	33 #include <string>
b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	34
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	35 namespace octave
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	36 {
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	37 class
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	38 OCTAVE_API
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	39 directory_path
8008 4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	40 {
4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	41 public:
4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	42
26174 94fc8648f0fe eliminate some unused and unnecessary path expansion code John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	43 directory_path (const std::string& s = "");
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	44
24991 831389905438 omit argument name from default copy ctors and assignment operators John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	45 directory_path (const directory_path&) = default;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	46
24991 831389905438 omit argument name from default copy ctors and assignment operators John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	47 directory_path& operator = (const directory_path&) = default;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	48
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	49 ~directory_path (void) = default;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	50
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	51 void set (const std::string& s)
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	52 {
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	53 m_initialized = false;
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	54 m_orig_path = s;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	55 init ();
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	56 }
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	57
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	58 std::list<std::string> elements (void);
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	59
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	60 std::list<std::string> all_directories (void);
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	61
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	62 std::string find_first (const std::string&);
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	63
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	64 std::string find (const std::string& nm) { return find_first (nm); }
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	65
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	66 std::list<std::string> find_all (const std::string&);
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	67
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	68 std::string find_first_of (const std::list<std::string>& names);
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	69
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	70 std::list<std::string>
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	71 find_all_first_of (const std::list<std::string>& names);
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	72
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	73 void rehash (void)
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	74 {
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	75 m_initialized = false;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	76 init ();
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	77 }
8008 4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	78
23743 e919cc8d9d92 don't use singleton pattern in pathsearch class; treat pathsep as constant John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	79 static char path_sep_char (void);
8008 4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	80
23743 e919cc8d9d92 don't use singleton pattern in pathsearch class; treat pathsep as constant John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	81 // static void path_sep_char (char c);
9266 1d3b91166b9c allow pathsep to be set John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	82
23743 e919cc8d9d92 don't use singleton pattern in pathsearch class; treat pathsep as constant John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	83 static std::string path_sep_str (void);
8008 4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	84
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	85 static bool is_path_sep (char c) { return c == path_sep_char (); }
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	86
8008 4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	87 private:
4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	88
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	89 // The colon separated list that we were given.
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	90 std::string m_orig_path;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	91
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	92 // TRUE means we've unpacked the path p.
0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	93 bool m_initialized;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	94
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	95 // A version of the colon separate list on which we have performed
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	96 // tilde, variable, and possibly default path expansion.
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	97 std::string m_expanded_path;
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	98
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	99 // The elements of the list.
21867 0cdfd6d230e6 use std::list<std::string> instead of string_vector in pathsearch functions John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	100 std::list<std::string> m_path_elements;
13983 7dd7cccf0757 clean up memory allocated for singletons before exit John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	101
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	102 void init (void);
8008 4d13a7a2f6ab dir_path: use singleton class for static data members John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	103 };
21745 bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	104 }
bf1121302404 use namespace for dir_path class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	105
1786 b9e8c73e154e [project @ 1996-01-24 20:36:22 by jwe] jwe parents: diff changeset	106 #endif

Mercurial > octave

annotate liboctave/util/pathsearch.h @ 27919:1891570abac8