Design Pattern Examples
Overview of object-oriented design patterns
c/Visitor_Shop.h
Go to the documentation of this file.
1
6
7#pragma once
8#ifndef __VISITOR_SHOP_H__
9#define __VISITOR_SHOP_H__
10
11#include "helpers/mapofstrings.h"
12#include "helpers/mapofint.h"
13
14struct OrderVisitor; // forward declaration
15
19typedef enum
20{
21 PlaceOrderResponse_OrderAccepted,
22 PlaceOrderResponse_OrderIgnored,
23 PlaceOrderResponse_Error
24} PlaceOrderReponse;
25
29typedef struct
30{
31 const char* Name;
32 const char* Address;
33 struct Village* Village;
34 MapOfStrings IngredientsForItems;
35 MapOfInt Inventory;
36} Visitor_Shop;
37
38//-----------------------------------------------------------------------------
39
49Visitor_Shop* Shop_Create(const char* name, const char* address, struct Village* village);
50
57void Shop_Destroy(Visitor_Shop* shop);
58
59
71PlaceOrderReponse Shop_PlaceOrder(Visitor_Shop* shop, ConstStringList* itemsToOrder);
72
87bool Shop_PickupOrder(Visitor_Shop* shop, ConstStringList* items, ConstStringList* itemsToBePickedUp);
88
89#endif // __VISITOR_SHOP_H__
90
Shop_PickupOrder
bool Shop_PickupOrder(Visitor_Shop *shop, ConstStringList *items, ConstStringList *itemsToBePickedUp)
Pick up the items sold by this shop (assumes the items were ordered already). Basically,...
Definition: Visitor_Shop.c:331
Shop_Destroy
void Shop_Destroy(Visitor_Shop *shop)
Destroy an instance of the Visitor_Shop structure, freeing up any memory that may have been allocated...
Definition: Visitor_Shop.c:163
PlaceOrderReponse
PlaceOrderReponse
Represents the possible responses from the Shop_PlaceOrder() function.
Definition: c/Visitor_Shop.h:20
PlaceOrderResponse_OrderIgnored
@ PlaceOrderResponse_OrderIgnored
Order was ignored.
Definition: c/Visitor_Shop.h:22
PlaceOrderResponse_Error
@ PlaceOrderResponse_Error
There was an error placing the order, likely an out of memory condition.
Definition: c/Visitor_Shop.h:23
PlaceOrderResponse_OrderAccepted
@ PlaceOrderResponse_OrderAccepted
Order was accepted.
Definition: c/Visitor_Shop.h:21
Shop_Create
Visitor_Shop * Shop_Create(const char *name, const char *address, struct Village *village)
Creates a new instance of a Visitor_Shop structure, and initializes it with the given name,...
Definition: Visitor_Shop.c:140
Shop_PlaceOrder
PlaceOrderReponse Shop_PlaceOrder(Visitor_Shop *shop, ConstStringList *itemsToOrder)
Visit the specified Visitor_Shop object to try to place an order as described in the OrderVisitor obj...
Definition: Visitor_Shop.c:177
mapofint.h
Declaration of the MapOfInt structure and supporting functions for managing a map of integers keyed b...
_ConstStringList
Represents a list of pointers to zero-terminated strings that are to remain constant and never delete...
Definition: conststringlist.h:19
MapOfInt
Represents a list of MapOfIntEntry objects that maps a string to an integer value....
Definition: mapofint.h:27
MapOfStrings
Represents a list of structures that map strings to ConstStringList objects.
Definition: helpers/mapofstrings.h:31
OrderVisitor
Represents a visitor used for ordering items from various shops. The user starts with an instance of ...
Definition: Visitor_OrderVisitor.h:21
Village
Represents a collection of shops that can be visited.
Definition: c/Visitor_Village.h:19
Visitor_Shop
Represents a shop in the village that can be visited.
Definition: c/Visitor_Shop.h:30
Visitor_Shop::Name
const char * Name
Name of shop. Borrowed pointer.
Definition: c/Visitor_Shop.h:31
Visitor_Shop::Address
const char * Address
Address of shop. Borrowed pointer.
Definition: c/Visitor_Shop.h:32
Visitor_Shop::Inventory
MapOfInt Inventory
Maps ingredient to number of that ingredient in the shop.
Definition: c/Visitor_Shop.h:35
Visitor_Shop::Village
struct Village * Village
Village this shop is in. Borrowed pointer.
Definition: c/Visitor_Shop.h:33
Visitor_Shop::IngredientsForItems
MapOfStrings IngredientsForItems
Maps ingredient to list of items need for ingredient.
Definition: c/Visitor_Shop.h:34