core/testlib/testlib_root_dir.h
Go to the documentation of this file.
00001 #ifndef testlib_root_dir_h_
00002 #define testlib_root_dir_h_
00003 //:
00004 // \file
00005 // \brief Function to return root directory (i.e. the parent directory of both core and contrib).
00006 // \author Tim Cootes
00007 // \verbatim
00008 //    Modifications
00009 //     17-05-2001 I. Scott - Moved from vul to testlib
00010 // \endverbatim
00011 #include <vcl_string.h>
00012 
00013 //: Return source root directory (i.e. the parent directory of both core and contrib).
00014 // *** Only use this directory tree for read-only operations! ***
00015 //
00016 //  If the file vcl_where_root_dir.h has been automatically generated
00017 //  during configuration (which will happen with cmake) then the
00018 //  appropriate source directory will be returned.
00019 //
00020 //  If another build system is used in which this is not created,
00021 //  the function will return the value of either of the environment
00022 //  variables: VXLSRC, VCLSRC or VXL_SRC in that order.
00023 vcl_string testlib_root_dir();
00024 
00025 #endif // testlib_root_dir_h_