worklist.h

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 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.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
#pragma once
 
#include "registry.h"
 
#include "fc_types.h"
 
#define MAX_LEN_WORKLIST 64
#define MAX_NUM_WORKLISTS 16
 
// a worklist
struct worklist {
  int length;
  struct universal entries[MAX_LEN_WORKLIST];
};
 
void worklist_init(struct worklist *pwl);
 
int worklist_length(const struct worklist *pwl);
bool worklist_is_empty(const struct worklist *pwl);
bool worklist_peek(const struct worklist *pwl, struct universal *prod);
bool worklist_peek_ith(const struct worklist *pwl, struct universal *prod,
                       int idx);
void worklist_advance(struct worklist *pwl);
 
void worklist_copy(struct worklist *dst, const struct worklist *src);
void worklist_remove(struct worklist *pwl, int idx);
bool worklist_append(struct worklist *pwl, const struct universal *prod);
bool worklist_insert(struct worklist *pwl, const struct universal *prod,
                     int idx);
// Used in packets_gen.cpp
bool are_worklists_equal(const struct worklist *wlist1,
                         const struct worklist *wlist2);
 
// Iterate over all entries in the worklist.
#define worklist_iterate(_list, _p)                                         \
  {                                                                         \
    struct universal _p;                                                    \
    int _p##_index = 0;                                                     \
                                                                            \
    while (_p##_index < worklist_length(_list)) {                           \
      worklist_peek_ith(_list, &_p, _p##_index++);
 
#define worklist_iterate_end                                                \
  }                                                                         \
  }