grub-savannah-mirror/include/grub/archelp.h

/* archelp.h -- Archive helper functions */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2013  Free Software Foundation, Inc.
 *
 *  GRUB 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.
 *
 *  GRUB 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 GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GRUB_ARCHELP_HEADER
#define GRUB_ARCHELP_HEADER	1

#include <grub/fs.h>
#include <grub/file.h>

typedef enum
  {
    GRUB_ARCHELP_ATTR_TYPE = 0160000,
    GRUB_ARCHELP_ATTR_FILE = 0100000,
    GRUB_ARCHELP_ATTR_DIR = 0040000,
    GRUB_ARCHELP_ATTR_LNK = 0120000,
    GRUB_ARCHELP_ATTR_NOTIME = 0x80000000,
    GRUB_ARCHELP_ATTR_END = 0xffffffff
  } grub_archelp_mode_t;

struct grub_archelp_data;

struct grub_archelp_ops
{
  grub_err_t
  (*find_file) (struct grub_archelp_data *data, char **name,
		grub_int32_t *mtime,
		grub_archelp_mode_t *mode);

  char *
  (*get_link_target) (struct grub_archelp_data *data);

  void
  (*rewind) (struct grub_archelp_data *data);
};

grub_err_t
grub_archelp_dir (struct grub_archelp_data *data,
		  struct grub_archelp_ops *ops,
		  const char *path_in,
		  grub_fs_dir_hook_t hook, void *hook_data);

grub_err_t
grub_archelp_open (struct grub_archelp_data *data,
		   struct grub_archelp_ops *ops,
		   const char *name_in);

#endif