view src/help.h @ 14376:7dd6ac033e69

Warn when the default path is overwritten * load-path.h (dir_info): New member, is_init, true if this directory was set during init. (dir_info::dir_info): Initialise is_init param. (load_path::do_clear): Pass the new elements to add after clearing. (load_path::clear): Pass dummy empty elements. (load_path::do_set, load_path::do_append, load_path::do_add): Pass new bool if adding or setting an init directory. * load-path.cc (load_path::do_initalize, load_path::do_append, load_path::do_add): Pass around extra is_init argument. (do_set): Pass an std::set of new directories to do_append. (do_clear): Check if the init directories are getting removed and warn if so.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Thu, 16 Feb 2012 20:19:12 -0500
parents 72c96de7a403
children 4e9dc46d4125
line wrap: on
line source

/*

Copyright (C) 1993-2012 John W. Eaton

This file is part of Octave.

Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

Octave is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/

#if !defined (octave_help_h)
#define octave_help_h 1

#include <iosfwd>
#include <string>

class string_vector;

extern string_vector make_name_list (void);

extern OCTINTERP_API std::string raw_help (const std::string&, bool&);

// Name of the doc cache file specified on the command line.
// (--doc-cache-file file)
extern std::string Vdoc_cache_file;

// Name of the info file specified on command line.
// (--info-file file)
extern std::string Vinfo_file;

// Name of the info reader we'd like to use.
// (--info-program program)
extern std::string Vinfo_program;

extern std::string do_which (const std::string& name);

#endif