kicad/include/systemdirsappend.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2020 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

/**
 * System directories search utilities
 * @file systemdirsappend.h
 */

#ifndef INCLUDE__SYSTEM_DIRS_APPEND_H_
#define INCLUDE__SYSTEM_DIRS_APPEND_H_

#include <kiway.h>

class SEARCH_STACK;

/**
 * Append system places to \a aSearchStack in a platform specific way and pertinent
 * to KiCad programs.
 */
KICOMMON_API void SystemDirsAppend( SEARCH_STACK* aSearchStack );

/**
 * Initialize aDst SEARCH_STACK with KIFACE (DSO) specific settings.
 * Adds libraries, docs, template paths to the search stack.
 */
KICOMMON_API void GlobalPathsAppend( SEARCH_STACK* aDst, KIWAY::FACE_T aId );

#endif  // INCLUDE__SYSTEM_DIRS_APPEND_H_