Arabian Nights in C++ - Revision history

Root: /* Observações */

2021-03-03T16:24:46Z

Observações

← Older revision		Revision as of 16:24, 3 March 2021
Line 35:		Line 35:

	O operador '''<<''', aplicado aos génios e ao demónio, deve enviar para o stream de saída correspondente uma das seguintes cadeias de caracteres:		O operador '''<<''', aplicado aos génios e ao demónio, deve enviar para o stream de saída correspondente uma das seguintes cadeias de caracteres:
	* <span style="color: #cc0000">~~<tt>~~Friendly genie has granted~~</tt>~~</span> ~~<tt>~~#~~</tt>~~ <span style="color: #cc0000">~~<tt>~~wishes and still has~~</tt>~~</span> ~~<tt>~~#~~</tt>~~ <span style="color: #cc0000">~~<tt>~~to grant.~~</tt>~~</span> (# representam os contadores apropriados)		* <span style="color: #cc0000">'''Friendly genie has granted'''</span> '''#''' <span style="color: #cc0000">'''wishes and still has'''</span> '''#''' <span style="color: #cc0000">'''to grant.'''</span> (# representam os contadores apropriados)
	* <span style="color: #cc0000">~~<tt>~~Grumpy genie has granted a wish.~~</tt>~~</span> / <span style="color: #cc0000">~~<tt>~~Grumpy genie has a wish to grant.~~</tt>~~</span> (consoante já concedeu ou não o pedido)		* <span style="color: #cc0000">'''Grumpy genie has granted a wish.'''</span> / <span style="color: #cc0000">'''Grumpy genie has a wish to grant.'''</span> (consoante já concedeu ou não o pedido)
	* <span style="color: #cc0000">~~<tt>~~Recyclable demon has granted~~</tt>~~</span> ~~<tt>~~#~~</tt>~~ <span style="color: #cc0000">~~<tt>~~wishes.~~</tt>~~</span> / <span style="color: #cc0000">~~<tt>~~Demon has been recycled.~~</tt>~~</span> (antes e depois de recarregar uma lâmpada)		* <span style="color: #cc0000">'''Recyclable demon has granted'''</span> '''#''' <span style="color: #cc0000">'''wishes.'''</span> / <span style="color: #cc0000">'''Demon has been recycled.'''</span> (antes e depois de recarregar uma lâmpada)

	A função '''main''' deve executar a seguinte sequência de operações:		A função '''main''' deve executar a seguinte sequência de operações:

Root: /* Implementation */

2021-03-03T16:21:02Z

Implementation

← Older revision		Revision as of 16:21, 3 March 2021
Line 53:		Line 53:
	== Implementation ==		== Implementation ==

	The following corresponds to a possible telling of a special version of the Arabian Nights stories. In any implementation, the following concepts will exist in one form or another: ~~<tt>~~MagicLamp~~</tt>~~, ~~<tt>~~Genie~~</tt>~~ (a general type of genie, which may also describe the recyclable demon), ~~<tt>~~FriendlyGenie~~</tt>~~, ~~<tt>~~GrumpyGenie~~</tt>~~, and ~~<tt>~~RecyclableDemon~~</tt>~~.		The following corresponds to a possible telling of a special version of the Arabian Nights stories. In any implementation, the following concepts will exist in one form or another: '''MagicLamp''', '''Genie''' (a general type of genie, which may also describe the recyclable demon), '''FriendlyGenie''', '''GrumpyGenie''', and '''RecyclableDemon'''.

	In the following implementation, each class will be defined in a pair of files: a header file (.h) and a file containing method definitions (.cpp). Although C++ does not enforce (or even needs) this division, it is useful for managing complexity and makes code understanding easier. Thus, the following files will exist:		In the following implementation, each class will be defined in a pair of files: a header file (.h) and a file containing method definitions (.cpp). Although C++ does not enforce (or even needs) this division, it is useful for managing complexity and makes code understanding easier. Thus, the following files will exist:
	* For the magic lamp: ~~<tt>~~MagicLamp.h~~</tt>~~ (interface) and ~~<tt>~~MagicLamp.cpp~~</tt>~~ (implementation).		* For the magic lamp: '''MagicLamp.h''' (interface) and '''MagicLamp.cpp''' (implementation).
	* For the genies: ~~<tt>~~Genie.h~~</tt>~~; ~~<tt>~~FriendlyGenie.h~~</tt>~~; ~~<tt>~~GrumpyGenie.h~~</tt>~~; and ~~<tt>~~RecyclableDemon.h~~</tt>~~ (we did not use .cpp file because these classes are small).		* For the genies: '''Genie.h'''; '''FriendlyGenie.h'''; '''GrumpyGenie.h'''; and '''RecyclableDemon.h''' (we did not use .cpp file because these classes are small).
	* For the main function: ~~<tt>~~main.cpp~~</tt>~~.		* For the main function: '''main.cpp'''.

	Note that the namespace has not been taken into account for defining class names. Nevertheless, when organizing large projects, especially if multiple namespaces exist, it may be advisable to establish a parallel between namespaces and directories (much like packages in Java).		Note that the namespace has not been taken into account for defining class names. Nevertheless, when organizing large projects, especially if multiple namespaces exist, it may be advisable to establish a parallel between namespaces and directories (much like packages in Java).

	=== Class ~~<tt>~~MagicLamp~~</tt>~~ ===		=== Class '''MagicLamp''' ===

	File ~~<tt>~~MagicLamp.h~~</tt>~~ contains the interface and a few small functions:		File '''MagicLamp.h''' contains the interface and a few small functions:
	{{CollapsedCode\|Ficheiro MagicLamp.h\|		{{CollapsedCode\|Ficheiro MagicLamp.h\|
	<source lang="c++" line>		<source lang="c++" line>
Line 151:		Line 151:
	}}		}}

	File ~~<tt>~~MagicLamp.cpp~~</tt>~~ contains the implementations of the functions not defined in the header (.h) file. Note how the destructor destroys all the genies and the demon when the lamp itself is destroyed (the only magic lamp is created in the stack of the main function - below - and its destructor is called at the end of the main function, when its stack is released).		File '''MagicLamp.cpp''' contains the implementations of the functions not defined in the header (.h) file. Note how the destructor destroys all the genies and the demon when the lamp itself is destroyed (the only magic lamp is created in the stack of the main function - below - and its destructor is called at the end of the main function, when its stack is released).

	{{CollapsedCode\|Ficheiro MagicLamp.cpp\|		{{CollapsedCode\|Ficheiro MagicLamp.cpp\|
Line 207:		Line 207:
	}}		}}

	=== Class ~~<tt>~~Genie~~</tt>~~ ===		=== Class '''Genie''' ===

	Class ~~<tt>~~Genie~~</tt>~~ defines the basic behaviour for all genies. The whole class is defined in the header file (Genie.h). Notice the two versions (one is commented out) of the output operator.		Class '''Genie''' defines the basic behaviour for all genies. The whole class is defined in the header file ('''Genie.h'''). Notice the two versions (one is commented out) of the output operator.

	Note that the output operator by itself if not capable of handling the polymorphic access used in the main function (because it is used as an argument). For it to work correctly, we defined an abstract method (~~<tt>~~dumpTo~~</tt>~~) that each class must implement. This method will be correctly called in polymorphic situations.		Note that the output operator by itself if not capable of handling the polymorphic access used in the main function (because it is used as an argument). For it to work correctly, we defined an abstract method ('''dumpTo''') that each class must implement. This method will be correctly called in polymorphic situations.

	Note also that, since ~~<tt>~~Genie~~</tt>~~ is a class whose methods are to be redefined by subclasses and whose pointers will only point to subclass instances, needs a virtual destructor: in this was, the ~~<tt>~~delete~~</tt>~~ operator will look at the actual type of the object (instead of using the type of the pointer), allowing the correct destructor (that of the object's class and not the pointer's) to be called.		Note also that, since '''Genie''' is a class whose methods are to be redefined by subclasses and whose pointers will only point to subclass instances, needs a virtual destructor: in this was, the '''delete''' operator will look at the actual type of the object (instead of using the type of the pointer), allowing the correct destructor (that of the object's class and not the pointer's) to be called.

	{{CollapsedCode\|Ficheiro Genie.h\|		{{CollapsedCode\|Ficheiro Genie.h\|
Line 303:		Line 303:
	}}		}}

	=== Class ~~<tt>~~FriendlyGenie~~</tt>~~ ===		=== Class '''FriendlyGenie''' ===

	A friendly genie is almost like a general genie (it differs in the output messages). Since it is a small class, it is completely defined in the header file (FriendlyGenie.h).		A friendly genie is almost like a general genie (it differs in the output messages). Since it is a small class, it is completely defined in the header file ('''FriendlyGenie.h''').

	{{CollapsedCode\|Ficheiro FriendlyGenie.h\|		{{CollapsedCode\|Ficheiro FriendlyGenie.h\|
Line 371:		Line 371:
	}}		}}

	=== Class ~~<tt>~~GrumpyGenie~~</tt>~~ ===		=== Class '''GrumpyGenie''' ===

	Like the other previous genie classes, this one is also very small and completely defined in the header file (GrumpyGenie.h):		Like the other previous genie classes, this one is also very small and completely defined in the header file ('''GrumpyGenie.h'''):

	{{CollapsedCode\|Ficheiro GrumpyGenie.h\|		{{CollapsedCode\|Ficheiro GrumpyGenie.h\|
Line 428:		Line 428:
	}}		}}

	=== Class ~~<tt>~~RecyclableDemon~~</tt>~~ ===		=== Class '''RecyclableDemon''' ===

	The ~~<tt>~~RecyclableDemon~~</tt>~~ is a genie that implements some of the control methods in a special way (but still adheres to the template method defined by class ~~<tt>~~Genie~~</tt>~~). Like the other small classes, it is completely define in ~~<tt>~~RecyclableDemon.h~~</tt>~~:		The '''RecyclableDemon''' is a genie that implements some of the control methods in a special way (but still adheres to the template method defined by class '''Genie'''). Like the other small classes, it is completely define in '''RecyclableDemon.h''':

	{{CollapsedCode\|Ficheiro RecyclableDemon.h\|		{{CollapsedCode\|Ficheiro RecyclableDemon.h\|
Line 505:		Line 505:
	=== Main Function ===		=== Main Function ===

	In this case, the ~~<tt>~~main~~</tt>~~ is, straightforward. Some aspects merit attention: since the magic lamp will not be used anywhere else, it is a good ideia to create in within the context of the main function, i.e., on its stack, and not on the heap (as would be the case if it were created with the "new" operator).		In this case, the '''main''' is, straightforward. Some aspects merit attention: since the magic lamp will not be used anywhere else, it is a good ideia to create in within the context of the main function, i.e., on its stack, and not on the heap (as would be the case if it were created with the "new" operator).

	{{CollapsedCode\|Função principal (main)\|		{{CollapsedCode\|Função principal (main)\|
Line 562:		Line 562:
	g++ -o an MagicLamp.o main.o		g++ -o an MagicLamp.o main.o

	The result of running the ~~<tt>~~an~~</tt>~~ application is the following:		The result of running the '''an''' application is the following:

	Grumpy genie has a wish to grant.		Grumpy genie has a wish to grant.

Root: /* Class MagicLamp */

2021-03-03T16:08:41Z

Class MagicLamp

← Older revision		Revision as of 16:08, 3 March 2021
Line 78:		Line 78:

	namespace arabiannights {		namespace arabiannights {

	~~class Genie; // just a declaration~~
	~~class RecyclableDemon; // just a declaration~~

	class MagicLamp {		class MagicLamp {

Root: /* Main Function */

2021-03-03T16:07:24Z

Main Function

← Older revision		Revision as of 16:07, 3 March 2021
Line 514:		Line 514:
	#include <iostream>		#include <iostream>
	#include "MagicLamp.h"		#include "MagicLamp.h"

	~~namespace arabiannights {~~
	~~class Genie;~~
	~~class RecyclableDemon;~~
	}

	int main() {		int main() {

Root: /* Class Genie */

2020-02-19T15:41:34Z

Class Genie

← Older revision		Revision as of 15:41, 19 February 2020
Line 236:		Line 236:

	protected:		protected:
	// only instances from ~~superclasses~~ are allowed		// only instances from subclasses are allowed
	Genie(int limit) : _limit(limit), _granted(0) {}		Genie(int limit) : _limit(limit), _granted(0) {}

Root at 00:09, 8 November 2018

2018-11-08T00:09:29Z

← Older revision		Revision as of 00:09, 8 November 2018
Line 2:		Line 2:
	== The Problem (in Portuguese) ==		== The Problem (in Portuguese) ==

	~~<span lang="pt">~~Aplicando os conceitos OO que já conhece, concretize as classes necessárias para representar a funcionalidade que se descreve de seguida. Pode ser necessária a criação de classes adicionais não descritas abaixo. Todas as classes indicadas devem pertencer ao namespace '''arabiannights'''.		Aplicando os conceitos OO que já conhece, concretize as classes necessárias para representar a funcionalidade que se descreve de seguida. Pode ser necessária a criação de classes adicionais não descritas abaixo. Todas as classes indicadas devem pertencer ao namespace '''arabiannights'''.

	=== Funcionalidade da lâmpada mágica (classe '''MagicLamp''') ===		=== Funcionalidade da lâmpada mágica (classe '''MagicLamp''') ===
Line 66:		Line 66:
	File <tt>MagicLamp.h</tt> contains the interface and a few small functions:		File <tt>MagicLamp.h</tt> contains the interface and a few small functions:
	{{CollapsedCode\|Ficheiro MagicLamp.h\|		{{CollapsedCode\|Ficheiro MagicLamp.h\|
	<source lang="c++">		<source lang="c++" line>
	#ifndef __ARABIANNIGHTS_MAGICLAMP_H__		#ifndef __ARABIANNIGHTS_MAGICLAMP_H__
	#define __ARABIANNIGHTS_MAGICLAMP_H__		#define __ARABIANNIGHTS_MAGICLAMP_H__
Line 157:		Line 157:

	{{CollapsedCode\|Ficheiro MagicLamp.cpp\|		{{CollapsedCode\|Ficheiro MagicLamp.cpp\|
	<source lang="c++">		<source lang="c++" line>
	#include "MagicLamp.h"		#include "MagicLamp.h"

Line 219:		Line 219:

	{{CollapsedCode\|Ficheiro Genie.h\|		{{CollapsedCode\|Ficheiro Genie.h\|
	<source lang="c++">		<source lang="c++" line>
	#ifndef __ARABIANNIGHTS_GENIE_H__		#ifndef __ARABIANNIGHTS_GENIE_H__
	#define __ARABIANNIGHTS_GENIE_H__		#define __ARABIANNIGHTS_GENIE_H__
Line 311:		Line 311:

	{{CollapsedCode\|Ficheiro FriendlyGenie.h\|		{{CollapsedCode\|Ficheiro FriendlyGenie.h\|
	<source lang="c++">		<source lang="c++" line>
	#ifndef __ARABIANNIGHTS_FRIENDLYGENIE_H__		#ifndef __ARABIANNIGHTS_FRIENDLYGENIE_H__
	#define __ARABIANNIGHTS_FRIENDLYGENIE_H__		#define __ARABIANNIGHTS_FRIENDLYGENIE_H__
Line 379:		Line 379:

	{{CollapsedCode\|Ficheiro GrumpyGenie.h\|		{{CollapsedCode\|Ficheiro GrumpyGenie.h\|
	<source lang="c++">		<source lang="c++" line>
	#ifndef __ARABIANNIGHTS_GRUMPYGENIE_H__		#ifndef __ARABIANNIGHTS_GRUMPYGENIE_H__
	#define __ARABIANNIGHTS_GRUMPYGENIE_H__		#define __ARABIANNIGHTS_GRUMPYGENIE_H__
Line 436:		Line 436:

	{{CollapsedCode\|Ficheiro RecyclableDemon.h\|		{{CollapsedCode\|Ficheiro RecyclableDemon.h\|
	<source lang="c++">		<source lang="c++" line>
	#ifndef __ARABIANNIGHTS_RECYCLABLEDEMON_H__		#ifndef __ARABIANNIGHTS_RECYCLABLEDEMON_H__
	#define __ARABIANNIGHTS_RECYCLABLEDEMON_H__		#define __ARABIANNIGHTS_RECYCLABLEDEMON_H__
Line 511:		Line 511:

	{{CollapsedCode\|Função principal (main)\|		{{CollapsedCode\|Função principal (main)\|
	<source lang="c++">		<source lang="c++" line>
	#include <iostream>		#include <iostream>
	#include "MagicLamp.h"		#include "MagicLamp.h"

Root at 10:23, 7 November 2018

2018-11-07T10:23:39Z

Show changes

Root: /* Class MagicLamp */

2018-11-07T10:22:10Z

Class MagicLamp

← Older revision		Revision as of 10:22, 7 November 2018
Line 66:		Line 66:
	File <tt>MagicLamp.h</tt> contains the interface and a few small functions:		File <tt>MagicLamp.h</tt> contains the interface and a few small functions:
	{{CollapsedCode\|Ficheiro MagicLamp.h\|		{{CollapsedCode\|Ficheiro MagicLamp.h\|
	<~~cpp~~>		<source lang="c++">
	#ifndef __ARABIANNIGHTS_MAGICLAMP_H__		#ifndef __ARABIANNIGHTS_MAGICLAMP_H__
	#define __ARABIANNIGHTS_MAGICLAMP_H__		#define __ARABIANNIGHTS_MAGICLAMP_H__
Line 151:		Line 151:

	#endif		#endif
	</~~cpp~~>		</source>
	}}		}}

Line 157:		Line 157:

	{{CollapsedCode\|Ficheiro MagicLamp.cpp\|		{{CollapsedCode\|Ficheiro MagicLamp.cpp\|
	<~~cpp~~>		<source lang="c++">
	#include "MagicLamp.h"		#include "MagicLamp.h"

Line 207:		Line 207:
	}		}
	}		}
	</~~cpp~~>		</source>
	}}		}}

Root: /* The Problem (in Portuguese) */

2016-02-19T08:03:37Z

The Problem (in Portuguese)

← Older revision		Revision as of 08:03, 19 February 2016
Line 2:		Line 2:
	== The Problem (in Portuguese) ==		== The Problem (in Portuguese) ==

	<span lang="pt">Aplicando os conceitos OO que já conhece, concretize as classes necessárias para representar a funcionalidade que se descreve de seguida. Pode ser necessária a criação de classes adicionais não descritas abaixo. Todas as classes indicadas devem pertencer ao ~~"~~namespace~~" <tt><span style="color: #cc0000">~~arabiannights~~</span></tt>~~.		<span lang="pt">Aplicando os conceitos OO que já conhece, concretize as classes necessárias para representar a funcionalidade que se descreve de seguida. Pode ser necessária a criação de classes adicionais não descritas abaixo. Todas as classes indicadas devem pertencer ao namespace '''arabiannights'''.

	=== Funcionalidade da lâmpada mágica (classe '''MagicLamp''') ===		=== Funcionalidade da lâmpada mágica (classe '''MagicLamp''') ===

Root: /* Observações */

2016-02-19T08:02:57Z

Observações

← Older revision		Revision as of 08:02, 19 February 2016
Line 32:		Line 32:
	=== Observações ===		=== Observações ===

	Todas as classes devem ter métodos de acesso (~~<em>~~get~~</em>~~ e ~~<em>~~set~~</em>~~) (quando apropriado) para os seus atributos.		Todas as classes devem ter métodos de acesso (''get'' e ''set'') (quando apropriado) para os seus atributos.

	O operador <~~tt>~~<~~span style="color: #cc0000"><<</span></tt>~~, aplicado aos génios e ao demónio, deve enviar para o stream de ~~saÃda~~ correspondente uma das seguintes cadeias de caracteres:		O operador '''<<''', aplicado aos génios e ao demónio, deve enviar para o stream de saída correspondente uma das seguintes cadeias de caracteres:
	* <span style="color: #cc0000"><tt>Friendly genie has granted</tt></span> <tt>#</tt> <span style="color: #cc0000"><tt>wishes and still has</tt></span> <tt>#</tt> <span style="color: #cc0000"><tt>to grant.</tt></span> (# representam os contadores apropriados)		* <span style="color: #cc0000"><tt>Friendly genie has granted</tt></span> <tt>#</tt> <span style="color: #cc0000"><tt>wishes and still has</tt></span> <tt>#</tt> <span style="color: #cc0000"><tt>to grant.</tt></span> (# representam os contadores apropriados)
	* <span style="color: #cc0000"><tt>Grumpy genie has granted a wish.</tt></span> / <span style="color: #cc0000"><tt>Grumpy genie has a wish to grant.</tt></span> (consoante já concedeu ou não o pedido)		* <span style="color: #cc0000"><tt>Grumpy genie has granted a wish.</tt></span> / <span style="color: #cc0000"><tt>Grumpy genie has a wish to grant.</tt></span> (consoante já concedeu ou não o pedido)
	* <span style="color: #cc0000"><tt>Recyclable demon has granted</tt></span> <tt>#</tt> <span style="color: #cc0000"><tt>wishes.</tt></span> / <span style="color: #cc0000"><tt>Demon has been recycled.</tt></span> (antes e depois de recarregar uma lâmpada)		* <span style="color: #cc0000"><tt>Recyclable demon has granted</tt></span> <tt>#</tt> <span style="color: #cc0000"><tt>wishes.</tt></span> / <span style="color: #cc0000"><tt>Demon has been recycled.</tt></span> (antes e depois de recarregar uma lâmpada)

	A função ~~<tt><span style="color: #cc0000">~~main~~</span></tt>~~ deve executar a seguinte ~~sequÃªncia~~ de operações:		A função '''main''' deve executar a seguinte sequência de operações:
	# Criar uma lâmpada mágica com capacidade para 4 génios.		# Criar uma lâmpada mágica com capacidade para 4 génios.
	# Esfregar 5 vezes a lâmpada, indicando os números de desejos 2, 3, 4, 5, 1.		# Esfregar 5 vezes a lâmpada, indicando os números de desejos 2, 3, 4, 5, 1.
	# Imprimir em ~~<tt><span style="color: #cc0000">~~std::cout~~</span></tt>~~ (utilizando o operador <~~tt><span style="color: #cc0000"><<</span>~~<~~/tt>~~) cada um dos génios.		# Imprimir em '''std::cout''' (utilizando o operador '''<<''') cada um dos génios.
	# Pedir um desejo a cada um dos génios.		# Pedir um desejo a cada um dos génios.
	# Imprimir em ~~<tt><span style="color: #cc0000">~~std::cout~~</span></tt>~~ (utilizando o operador <~~tt><span style="color: #cc0000"><<</span>~~<~~/tt>~~) cada um dos génios.		# Imprimir em '''std::cout''' (utilizando o operador '''<<''') cada um dos génios.
	# Pedir um desejo a cada um dos génios.		# Pedir um desejo a cada um dos génios.
	# Imprimir em ~~<tt><span style="color: #cc0000">~~std::cout~~</span></tt>~~ (utilizando o operador <~~tt><span style="color: #cc0000"><<</span>~~<~~/tt>~~) cada um dos génios.		# Imprimir em '''std::cout''' (utilizando o operador '''<<''') cada um dos génios.
	# Colocar o demónio reciclável na lâmpada.		# Colocar o demónio reciclável na lâmpada.
	# Esfregar a lâmpada, indicando 7 como número de desejos.		# Esfregar a lâmpada, indicando 7 como número de desejos.
	# Imprimir em ~~<tt><span style="color: #cc0000">~~std::cout~~</span></tt>~~ (utilizando o operador <~~tt><span style="color: #cc0000"><<</span>~~<~~/tt>~~) o génio obtido.		# Imprimir em '''std::cout''' (utilizando o operador '''<<''') o génio obtido.

	== Implementation ==		== Implementation ==