// swad_room.h: classrooms, laboratories, offices or other rooms in a centre

#ifndef _SWAD_ROO
#define _SWAD_ROO
/*
    SWAD (Shared Workspace At a Distance in Spanish),
    is a web platform developed at the University of Granada (Spain),
    and used to support university teaching.

    This file is part of SWAD core.
    Copyright (C) 1999-2020 Antonio Caņas Vargas

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
/*****************************************************************************/
/********************************** Headers **********************************/
/*****************************************************************************/

#include "swad_string.h"

/*****************************************************************************/
/************************** Public types and constants ***********************/
/*****************************************************************************/

#define Roo_MAX_CHARS_SHRT_NAME	(32 - 1)	// 31
#define Roo_MAX_BYTES_SHRT_NAME	((Roo_MAX_CHARS_SHRT_NAME + 1) * Str_MAX_BYTES_PER_CHAR - 1)	// 511

#define Roo_MAX_CHARS_FULL_NAME	(128 - 1)	// 127
#define Roo_MAX_BYTES_FULL_NAME	((Roo_MAX_CHARS_FULL_NAME + 1) * Str_MAX_BYTES_PER_CHAR - 1)	// 2047

#define Roo_MAX_CAPACITY	10000	// If capacity of a room is greater than this, it is considered infinite
#define Roo_UNLIMITED_CAPACITY	INT_MAX	// This number can be stored in database as an integer...
					// ...and means that a room has no limited capacity

#define Roo_MAX_CHARS_LOCATION	(128 - 1)	// 127
#define Roo_MAX_BYTES_LOCATION	((Roo_MAX_CHARS_LOCATION + 1) * Str_MAX_BYTES_PER_CHAR - 1)	// 2047

struct Roo_Room
  {
   long RooCod;
   long CtrCod;
   long BldCod;
   int Floor;
   char ShrtName[Roo_MAX_BYTES_SHRT_NAME + 1];
   char FullName[Roo_MAX_BYTES_FULL_NAME + 1];
   unsigned Capacity;				// Seating capacity (maximum number of people that fit in the room)
   char Location[Roo_MAX_BYTES_LOCATION + 1];	// Examples: Ground floor, first floor, basement
  };

#define Roo_NUM_ORDERS 4
typedef enum
  {
   Roo_ORDER_BY_SHRT_NAME = 0,
   Roo_ORDER_BY_FULL_NAME = 1,
   Roo_ORDER_BY_CAPACITY  = 2,
   Roo_ORDER_BY_LOCATION  = 3,
  } Roo_Order_t;
#define Roo_ORDER_DEFAULT Roo_ORDER_BY_LOCATION

/***** Get all data or only short name *****/
typedef enum
  {
   Roo_ALL_DATA,
   Roo_ONLY_SHRT_NAME,
  } Roo_WhichData_t;

struct Roo_Rooms
  {
   unsigned Num;		// Number of rooms
   struct Roo_Room *Lst;	// List of rooms
   Roo_Order_t SelectedOrder;
  };

/*****************************************************************************/
/***************************** Public prototypes *****************************/
/*****************************************************************************/

void Roo_ResetRooms (struct Roo_Rooms *Rooms);

void Roo_SeeRooms (void);
void Roo_EditRooms (void);
void Roo_PutIconToViewRooms (void);
void Roo_GetListRooms (struct Roo_Rooms *Rooms,
                       Roo_WhichData_t WhichData);
void Roo_FreeListRooms (struct Roo_Rooms *Rooms);

void Roo_GetListRoomsInThisCtr (void);

void Roo_GetDataOfRoomByCod (struct Roo_Room *Roo);
long Roo_GetParamRooCod (void);

void Roo_RemoveRoom (void);
void Roo_RemoveAllRoomsInCtr (long CtrCod);
void Roo_ChangeBuilding (void);
void Roo_ChangeFloor (void);
void Roo_RenameRoomShort (void);
void Roo_RenameRoomFull (void);
void Roo_ChangeCapacity (void);
void Roo_ChangeRoomLocation (void);
void Roo_ContEditAfterChgRoom (void);

void Roo_RecFormNewRoom (void);

#endif