swad-core/swad_program.h

// swad_program.h: course program

#ifndef _SWAD_PRG
#define _SWAD_PRG
/*
    SWAD (Shared Workspace At a Distance),
    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-2023 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 <stdbool.h>		// For boolean type
#include <time.h>		// For time

#include "swad_database.h"
#include "swad_date.h"

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

#define PrgRsc_MAX_CHARS_PROGRAM_RESOURCE_TITLE	(128 - 1)	// 127
#define PrgRsc_MAX_BYTES_PROGRAM_RESOURCE_TITLE	((PrgRsc_MAX_CHARS_PROGRAM_RESOURCE_TITLE + 1) * Str_MAX_BYTES_PER_CHAR - 1)	// 2047

struct Prg_ResourceHierarchy
  {
   long RscCod;
   unsigned RscInd;	// 1, 2, 3...
   bool Hidden;
  };

#define PrgRsc_NUM_TYPES 11
typedef enum
  {
  PrgRsc_NONE,
  // gui TEACHING_GUIDE	// Link to teaching guide
  // bib BIBLIOGRAPHY	// Link to bibliography
  // faq FAQ		// Link to FAQ
  // lnk LINKS		// Link to links
  // tmt TIMETABLE	// Link to timetable
  PrgRsc_ASSIGNMENT,
  PrgRsc_PROJECT,	// A project is only for some students
  PrgRsc_CALL_FOR_EXAM,
  // tst TEST		// User selects tags, teacher should select
  PrgRsc_EXAM,
  PrgRsc_GAME,
  PrgRsc_SURVEY,
  PrgRsc_DOCUMENT,
  PrgRsc_MARKS,
  // grp GROUPS		// ??? User select groups
  PrgRsc_ATTENDANCE_EVENT,
  PrgRsc_FORUM_THREAD,
  } PrgRsc_Type_t;

struct Prg_Link
  {
   PrgRsc_Type_t Type;
   long Cod;
  };

#define Prg_MAX_CHARS_PROGRAM_ITEM_TITLE	(128 - 1)	// 127
#define Prg_MAX_BYTES_PROGRAM_ITEM_TITLE	((Prg_MAX_CHARS_PROGRAM_ITEM_TITLE + 1) * Str_MAX_BYTES_PER_CHAR - 1)	// 2047

struct Prg_ItemHierarchy
  {
   long ItmCod;
   unsigned ItmInd;	// 1, 2, 3...
   unsigned Level;
   bool Hidden;
  };

struct Prg_Item
  {
   struct Prg_ItemHierarchy Hierarchy;
   unsigned NumItem;
   long UsrCod;
   time_t TimeUTC[Dat_NUM_START_END_TIME];
   bool Open;
   char Title[Prg_MAX_BYTES_PROGRAM_ITEM_TITLE + 1];
   struct
     {
      struct Prg_ResourceHierarchy Hierarchy;
      struct Prg_Link Link;
      char Title[PrgRsc_MAX_BYTES_PROGRAM_RESOURCE_TITLE + 1];
     } Resource;
  };

struct Prg_ItemRange
  {
   unsigned Begin;	// Index of the first item in the subtree
   unsigned End;	// Index of the last item in the subtree
  };

#define Prg_NUM_MOVEMENTS_LEFT_RIGHT 2
typedef enum
  {
   Prg_MOVE_LEFT,
   Prg_MOVE_RIGHT,
  } Prg_MoveLeftRight_t;

#define Prg_NUM_MOVEMENTS_EXPAND_CONTRACT 2
typedef enum
  {
   Prg_EXPAND,
   Prg_CONTRACT,
  } Prg_ExpandContract_t;

#define Prg_NUM_LISTING_TYPES 12
typedef enum
  {
   Prg_PRINT,			// List items ready to be printed
   Prg_VIEW,			// List items without any edition

   Prg_EDIT_ITEMS,		// Buttons to edit list of items
   Prg_FORM_NEW_END_ITEM,	// Form to create a new first level item at the end
   Prg_FORM_NEW_CHILD_ITEM,	// Form to create a new child item
   Prg_FORM_EDIT_ITEM,		// Form to edit a selected item
   Prg_END_EDIT_ITEM,		// List item after edition
   Prg_RECEIVE_ITEM,		// Receive item data after create/edit

   Prg_EDIT_RESOURCES,		// List resources of a selected item for edition
   Prg_EDIT_RESOURCE_LINK,	// Show clipboard in a resource to select a link
   Prg_CHANGE_RESOURCE_LINK,	// Change resource link
   Prg_END_EDIT_RES,		// List resources of a selected item after edition
  } Prg_ListingType_t;

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

void Prg_ShowCourseProgram (void);
void Prg_EditCourseProgram (void);

void Prg_ShowAllItems (Prg_ListingType_t ListingType,
                       long SelectedItmCod,long SelectedRscCod);

bool Prg_CheckIfICanEditProgram (void);

void Prg_PutParItmCod (void *ItmCod);
void Prg_GetPars (struct Prg_Item *Item);

void Prg_GetListItems (void);
void Prg_FreeListItems (void);

void Prg_ResetItem (struct Prg_Item *Item);
void Prg_ResetResource (struct Prg_Item *Item);

unsigned Prg_GetNumItemFromItmCod (long ItmCod);
long Prg_GetItmCodFromNumItem (unsigned NumItem);
unsigned Prg_GetItmIndFromNumItem (unsigned NumItem);
unsigned Prg_GetLevelFromNumItem (unsigned NumItem);

void Prg_ViewItemAfterEdit (void);
void Prg_ReqChangeItem (void);
void Prg_ReqCreateItem (void);
void Prg_ReceiveFormChgItem (void);
void Prg_ReceiveFormNewItem (void);

void Prg_ReqRemItem (void);
void Prg_RemoveItem (void);
void Prg_HideItem (void);
void Prg_UnhideItem (void);

void Prg_MoveUpItem (void);
void Prg_MoveDownItem (void);
void Prg_MoveLeftItem (void);
void Prg_MoveRightItem (void);

void Prg_ExpandItem (void);
void Prg_ContractItem (void);

//-------------------------------- Figures ------------------------------------
void Prg_GetAndShowCourseProgramStats (void); // TODO: Change function from assignments to schedule

#endif