[42SEOUL] CPP Module 05

Chapter 0

이번 과제의 주제는 반복과 예외이다. 지금까지는 예외가 발생하면 그 상태로 에러를 반환하는 형태로 프로그램을 구현했다. 즉, "예외 -> 프로그램 종료" 라는 형식으로 코드를 작성했는데, 이번 과제에서는 예외가 발생한다면 다시 입력을 받거나, 예외가 발생한 구간부터 사용자가 작성한 코드를 동작하도록 만들어야 하는 것으로 보인다.

먼저, 이번 과제에서 자주 쓰일 try - catch 문에 대해 알아보도록 하자.

Try - Catch

우리가 주로 사용하던 if문을 통한 예외처리 방식은 if 조건문이 굉장히 많이 쓰이고, 다방면으로 쓰이기 때문에 예외 처리를 위해 사용하는 것인지 한눈에 알아보기 힘들다. 이런 불편한 점 때문에, 가독성과 유지보수성을 위해 try-catch문을 사용하게 된다.

기본적으로 try-catch문은 다음과 같이 사용할 수 있다.

int main() {
  try {
    // 예외가 발생할것을 예상할 수 있는 코드들
  } catch {
    // 예외가 발생했다면 동작해야하는 코드들
  }
  // try - catch 문이 정상적으로 동작했다면 실행되어야 하는 코드들
}

이런식으로 사용할 수 있는데, try-catch문의 장점은 가독성을 높일 뿐만 아니라 예외 처리를 프로그램의 일반적인 흐름에서 독립시킬 수 있다는 점이 있다.

그럼 예외가 발생하는것을 어떻게 전달해야하는가 ?

그동안 프로그램에서 예외가 발생한다면 프로그램을 종료시키는 것이 일반적이었다. 그렇다면 try문에 예외가 발생했을 때 종료하는 코드를 작성한다면 catch문으로 넘어가는것일까 ??

그렇지 않다. try-catch문에서는 예외가 발생했음을 알리기 위해 throw를 사용한다.

if (조건문)
  throw "에러메세지";

이런식으로 try문 내부에 예외를 발생시키도록 throw를 배치한다면 throw문에서 그 즉시 예외를 발생했음을 알리고, catch문이 예외 발생을 감지한다.

throw문은 사용자의 구현 방식에 따라 여러가지 예외상황을 담은 데이터를 전달할 수 있다.
단순한 에러메세지를 전달하고자 한다면 다음과 같이 사용할 수 있다.

int main() {
  int num;

  while (1) {
    std::cout << "10 미만의 수 입력 : ";
    std::cin >> num;
    try {
      if (num >= 10)
        throw "잘못된 수를 입력했습니다. 다시 입력해주세요.";
      break;
    } catch (const char* message) {
      std::cout << message << std::endl;
    }
  }
  std::cout << "10 미만의 수 " << num << " 입력 완료 !";
  return 0;
}

이런식으로 throw에 데이터를 담아 전달해주면 catch에서 message라는 변수에 데이터를 받아서 사용할 수 있다.

만약 throw로 전달되는 타입을 모른다면 "catch(...)"으로 작성하면 어떤 타입의 예외든 처리를 해줄 수 있다.

std::exception

위처럼 if문을 통해 예외를 인지하고 throw를 통해 예외를 발생시키는 방법도 있지만, 시스템 내부에서 std::exception 클래스를 통해 예외를 발생시켜줄 수 있다.

이 exception 클래스는 what()이라는 가상 함수가 존재한다. exception 클래스를 상속받는 자식클래스인 runtime_error, logic_error 등에서 what 함수를 오버라이딩 해서 예외 발생 시 사용한다.

그렇다면 우리도 exception 클래스를 상속받아 what 함수를 오버라이딩 해서 새로운 예외 처리 클래스를 만들어줄 수 있겠다.

이걸 해보라고 하는것이 이번 과제의 목적이기 때문에 예제에서 후술하려 한다.

Chapter 1

Introduction

이 과제는 내가 걸어가야할 C++이라는 여행길에 시작점에 객체지향프로그래밍이 어떤건지를 설명해주는것이 목적이라고 한다.

객체지향은 많은 언어들이 사용하는데, 왜 C++을 배우게 되느냐.. 하면 나의 오랜 친구(42에서만)인 C에서 파생된 언어이기 때문이라고 한다.

C++은 복잡한 언어이기 때문에, 단순하게 유지하기 위해 내 코드를 C++ 98 standard로 컴파일 할것이라고 한다.

Chapter 2

General Rules

컴파일

• 너의 C++ 코드는 "-Wall -Wextra -Werror" 플래그와 함께 컴파일 한다.
• 너의 코드는 "-std=c++98"를 플래그로 추가하고도 컴파일이 되어야 한다.

포멧과 네임 컨벤션

• 모든 문제의 디렉토리는 다음의 방식을 따른다 : ex00, ex01, ex02 ... exn
• 너의 파일, 클래스, 함수, 멤버함수, 속성들은 가이드라인의 요구에 맞추어야 한다.
• 클래스 이름은 UpperCamelCase 형식을 사용한다. 클래스를 담은 파일의 이름은 클래스 이름을 따라야 한다.
• 얘를 들어, ClassName.hpp/ClassName.h, ClassName.cpp, ClassName.tpp 와 같은 형식이다. 그렇다면 "BrickWall"이라는 클래스를 담고있는 헤더의 이름은 BrickWall.hpp가 되어야 하는 것이다.
• 달리 명시하지 않았을 경우, 모든 출력 메세지는 개행문자로 끝나야 하며 표준 출력으로 보여주어야 한다.
• Goodbye Norminette! C++ 모듈에서는 코딩 스타일을 강요하지 않는다. 너가 좋아하는 것을 따라 할 수 있다. 하지만 동료평가시, 이해할 수 없는 코드를 사용할 경우, 동료들이 점수를 줄 수 없다는 것을 명심해라. 최선을 다해 클린하고 가독성 있는 코드를 작성하길 바란다.

허용되는 사항 / 금지되는 사항

너는 이제부터 C로 코딩하지 않는다. C++의 시간이다 ! 그러므로:

• 너는 표준 라이브러리에서의 거의 모든 것들을 사용할 수 있다. 따라서, 이미 알고 있는 것을 고수하는 대신, 익숙한 C함수의 C++ 버전을 최대한 많이 사용해보는 것이 현명할 것이다.
• 그러나, 너는 다른 외부 라이브러리를 사용할 수 없다. 이 말의 의미는 C++ 11과 Boost 라이브러리가 금지된다는 것이다. 다음 함수도 금지된다. printf(), alloc() and free(). 이걸 쓰면 너의 점수는 0점이 될 것이다.
• 달리 명시하지 않는 이상, namespace 및 friend 키워드의 사용은 금지된다. 사용하면 -42점이므로 주의하자.
• 오직 모듈 08에서만 STL의 사용이 허용된다. 이 뜻은, 컨테이너(vector, list, map and forth)와 알고리즘(<algorithm> 헤더가 포함된 어떠한 것들)이 허용되지 않는다는 것이다. 이 또한 사용하면 -42점이다.

몇 가지 디자인 요구사항

• 메모리 누수가 발생하는것은 C++도 동일하다. 만약 너가 메모리를 할당(new 키워드 사용으로)하면, 메모리 누수를 반드시 피해야한다.
• 모듈 02부터 08까지는 달리 명시된 경우를 제외하고, 클래스를 Orthodox Canonical Form으로 설계해야만 한다.
• 헤더파일에 선언되지 않은 함수들을 사용하는 경우 0점을 받는다.
• 각 헤더를 다른 헤더와 독립적으로 사용할 수 있어야 한다. 따라서 필요한 모든 종속성을 포함해야한다. 그러나 헤더가드를 사용해 이중으로 포함되는 것은 피해야만 한다. 그렇지 않으면 0점을 받을 것이다.

Read me

• 너는 필요(즉, 코드를 분할하기 위해)에 의해 파일을 추가할 수 있다. 이런 할당은 프로그램에서 확인하지 않으므로, 필수 파일을 제출하는 한 자유롭게 추가하면 된다.
• 때때로 과제의 가이드라인이 짧아보이지만, 명시적으로 작성되지 않은 요구사항들을 example에서 보여줄 수 있다.
• 시작 전에 꼭 모듈의 과제를 읽어야만 한다. 정말이다 !

Chapter 3

Ex00

문제

예외 클래스들은 OCCF로 작성하지 않아도 됨을 알아두자. 그렇지만 다른 모든 클래스들은 OCCF로 작성해야한다.

사무실, 복도, 양식 및 대기열의 인공적인 악몽을 설계해보자. 재밌겟다 ? 아니 ? 너무 나빠.

먼저, Bureaucrat이라는 이 방대한 관료적 기계의 가장 작은 톱니바퀴부터 시작하자.

Bureaucrat은 다음을 가지고 있다.

• const name
• 1부터 150까지 범위의 등급 (1이 제일 높고, 150이 가장 낮은 등급)

유효하지 않은 등급을 사용하여 Bureaucrat을 인스턴스화하려는 모든 시도는 예외를 발생시켜야 한다.

예외 : Bureaucrat::GradeTooHighException, Bureaucrat::GradeTooLowException

getName(), getGrade()로 두 속성 모두 getter를 제공할 것이다. 또한 등급의 증가와 감소를 위한 두 멤버 함수를 구현해라. 등급이 범위를 벗어나면, 둘 다 생성자와 동일한 예외를 발생해야한다.

기억해라. 1등급이 가장 높고, 150이 가장 낮기 때문에, 3등급을 증가시키면 2등급이 되어야 한다.

에러 발생은 try - catch를 사용해서 발생해야만 한다.

try
{
  /* do some stuff with bureaucrats */
}
catch (std::exception & e)
{
  /* handle exception */
}

(<<) 연산자 오버로드를 통해 다음과 같은 출력을 구현할 것이다. (괄호 빼고)

<name>, bureaucrat grade <grade>.

평소처럼, 모든 것이 예상대로 작동하는지 확인하기 위해 몇 가지 테스트를 실행하자.

구현

지금까지 해왔던 대로 클래스를 구현한다면 쉽게 Bureaucrat 클래스를 구현할 수 있을 것이다.

여기서 추가되는 점은, 예외 클래스를 정의해주어야 한다는 것이다. 과제에서는 Bureaucrat::GradeTooHighException과 같은 형식으로 예외를 발생시켜야 한다고 적혀있으므로, Bureaucrat 클래스 내부에 예외 발생 클래스를 정의해준다.

이 때, std::exception 클래스를 상속받아 what 함수를 오버라이딩해주는 형식으로 클래스를 구현하면 된다.

    * A assignment operator overload
    */
    Bureaucrat&    operator=(const Bureaucrat& ref);

    /*
    * A destructor
    */
    ~Bureaucrat();

    /*
    * Add it if you feel necessary additional member functions.
    */
    const std::string& getName() const;
    const int& getGrade() const;
    void incrementGrade();
    void decrementGrade();

    /*
    TODO: Any attempt to instantiate a Bureaucrat using an invalid grade must throw an exception:
    */
    class GradeTooHighException : public std::exception {
      public:
        const char* what() const throw();
    };
    class GradeTooLowException : public std::exception {
      public:
        const char* what() const throw();
    };
};

예외 처리 클래스를 보면, std::exception을 상속받은 GradeTooHighException 클래스를 만들어주고 있다.

이 중, 우리는 가상함수인 what 함수에 대해 오버라이딩을 해주면 된다.

const char* Bureaucrat::GradeTooHighException::what() const throw() {
  return "Grade is too high.";
}

메인문에 적절하게 테스트 작성 후 동작시켜보면 된다.

Ex01

문제

이제 bureaucrat가 생겼으니, 무언가 할 일을 주자. 양식 더미를 채우는 것보다 더 좋은 활동이 어디 있겠는가 ?

그렇다면, Form 클래스를 만들어보자. 그것은 :

• const name
• 사인 여부를 포함하는 boolean (생성자에서는 하지 않음으로)
• 사인 권한 등급
• 실행 권한 등급

이 모든것은 private 속성이다. protected가 아니다.

Form의 등급은 Bureaucrat에 적용되는 동일한 규칙을 따른다. 따라서 Form의 등급이 범위를 벗어나면 다음 예외가 발생한다.

Form::GradeTooHighException, Form::GradeTooLowException

전과 동일하게, 모든 속성에 대한 getter와 모든 양식의 정보를 출력하는 (<<) 연산자의 오버로드를 작성한다.

또한 Form에서 Bureaucrat을 인자로 받는 beSigned() 멤버 함수를 추가한다. 이것은 bureaucrat의 등급이 충분히 높을 경우(요구 등급보다 높거나 같음)에 form의 사인 상태를 바꾼다. 1등급이 2등급보다 높다는것을 기억해라. 등급이 너무 낮다면 Form::GradeTooLowException을 통해 예외를 발생해라.

마지막으로, signForm() 멤버 함수를 Bureaucrat에 추가하자. 만약 사인을 받았다면, 이것은 다음과 같이 출력할 것이다.

<bureaucrat> signed <form>

받지 않았다면, 다음을 출력할 것이다.

<bureaucrat> couldn't sign <form> because <reason>.

모든 것이 예상대로 작동하는지 확인하기 위해 몇 가지 테스트를 구현하고 제출하자.

구현

구현 펼치기

Form 클래스에 대해서는 과제에서 요구한 대로 구현을 했다.

class Form {
  private:
    /* data */
    const std::string _name;
    bool _beSigned;
    const int _signGrade;
    const int _executeGrade;

    Form();

  public:
    /*
    * A default constructor
    */
    Form(const std::string& name, const int& signGrade, const int& executeGrade);

    /*
    * A copy constructor
    */
    Form(const Form& ref);

    /*
    * A assignment operator overload
    */
    Form&    operator=(const Form& ref);

    /*
    * A destructor
    */
    ~Form();

    /*
    TODO: The grades of the Form follow the same rules that apply to the Bureaucrat. Thus, the following exceptions will be thrown if a form grade is out of bounds
    */
    class GradeTooHighException : public std::exception {
      public:
        const char* what() const throw();
    };
    class GradeTooLowException : public std::exception {
      public:
        const char* what() const throw();
    };

    /*
    * Add it if you feel necessary additional member functions.
    */

    /*
    * Getter
    */
    const std::string& getName() const;
    const bool& getBeSigned() const;
    const int& getSignGrade() const;
    const int& getExecuteGrade() const;

    void beSigned(const Bureaucrat& bureaucrat);
};

/*
* Add it if you feel necessary additional functions.
*/
std::ostream& operator<<(std::ostream& ofs, const Form& form);

어려운 구현을 요구하는 것이 아니라 난이도 자체는 괜찮았는데, Bureaucrat.hpp 에서는 Form.hpp를 불러오고, Form.hpp에서는 Bureaucrat.hpp를 불러오면서 오류가 발생했다. 한참 고민하다가 Bureaucrat.hpp에서 class Form을 먼저 선언해주는 것으로 해결했다.

Ex02

문제

기초 양식을 가지고 있으므로, 실제 작업을 수행하는 몇 가지 양식을 더 만들어 볼 차례이다.

모든 상황에서, 기본 클래스 Form은 추상 클래스가 되어야 하기 때문에, AForm으로 이름을 변경해야한다. Form의 속성은 private로 유지되어야 하며 기본 클래스에 남아있어야 함을 명심하자.

다음의 구체적인 클래스들을 추가하자.

• ShrubberyCreationForm: 요구 등급: sign 145, exec 137
• <target>_shrubbery 파일을 작업 디렉토리에 만들고, ASCII 트리를 파일 내부에 작성한다.
• RobotomyRequestForm: 요구 등급: sign 72, exec 45
• 약간의 드릴 소리를 낸다. 그리고, <target>은 50%의 시간 동안 성공적으로 로봇화되었음을 알린다. 그렇지 않다면, 로봇공학은 실패했음을 알린다.
• PresidentialPardonForm: 요구 등급: sign 25, exec 5
• <target>이 Zaphod Beeblebrox에 의해 사면되었음을 알린다.

그들 모두는 생성자에서 Form의 대상인 하나의 매개변수만 사용한다. 예를들어 shrubbery를 집에 심고 싶다면 "집"이라고 입력한다.

이제, execute(Bureaucrat const & executer) const 멤버 함수를 기본 form에 추가하고, 구체적인 클래스의 양식 동작을 실행하는 함수를 구현한다. 양식에 서명이 되어있고 양식을 실행하려는 bureaucrat의 등급이 충분히 높은지 확인해야한다. 그렇지 않다면 적절한 예외를 발생시킨다.

모든 구체적인 클래스 또는 기본 클래스에서 요구 사항을 확인하고 싶은지(그리고 다른 함수를 호출해 양식을 실행한다)는 사용자에게 달려있다. 그러나 한 가지 방법은 다른 방법보다 이쁘다.

마지막으로, Bureaucrat에 **executeForm(Form const & form) 멤버 함수를 추가한다. 이것은 form의 실행을 시도해야 한다. 성공한다면 다음과 같이 입력한다.

<bureaucrat> executed <form>

아니라면, 명시적인 에러메세지를 출력해라.

모든 것이 예상대로 작동하는지 확인하기 위해 몇 가지 테스트를 구현하고 제출해라.

구현

먼저, Form 클래스를 추상 클래스로 바꿔주어야 한다. 별로 달라지는건 없고, 새로 추가되는 AForm을 상속받는 세개의 클래스들에서 재정의해줄 execute 함수를 순수 가상 함수로 만들어주었다.

또한, 실행 권한 등급을 통한 실행 여부를 판단하는 멤버 함수를 만들어주어야 했기 때문에, 실행 권한 등급에 따른 예외처리 클래스도 만들어주었다.

    class NotGetSign : public std::exception {
      public:
        const char* what() const throw();
    };

    class CouldNotExecute : public std::exception {
      public:
        const char* what() const throw();
    };

그리고, Bureaucrat 클래스에서 Form의 실행을 담당하는 executeForm 멤버 함수를 만들어 주었는데, 이 함수 내부에서 execute 함수를 사용할 수 있도록 만들어, try-catch 문을 사용해 에러가 발생하면 에러를 출력할 수 있도록 만들어 주었다.

void Bureaucrat::executeForm(const AForm& form) const {
  try {
    (*const_cast<AForm*>(&form)).execute(*this);
    std::cout << this->getName() << " executed " << form.getName() << std::endl;
  } catch (std::exception& e) {
    std::cout << this->getName() << " couldn't execute " <<
      form.getName() << " because " << e.what() << std::endl;
  }
}

executeForm은 Form을 인자로 받는 함수이기 때문에, AForm을 상속받는 세개의 클래스를 모두 받아줄 수 있다. 하나의 executeForm 함수로 세 자식 클래스의 execute를 실행할 수 있게 되는 것이다.

3개의 클래스는 각각 실행했을 때의 결과가 달라야한다. 과제에 구체적으로 명시되어 있는데, 여럽지 않게 구현해줄 수 있다.

ShrubberyCreationForm은 권한을 만족했을 때, 작업 디렉토리 안에 ascii로 만들어진 나무를 <target>_shrubbery라는 파일에 저장해주어야 한다. 파일 저장은 module 01에서 해보았으니 쉽게 구현할 수 있을 것이고, 나무는 간단하게 직접 만들어주었다.

const std::string ShrubberyCreationForm::_treeOfAscii = "\
  ,      ,      ,,   ,\n\
      ,        ,     ,\n\
,         *       ,   \n\
         * *   ,     ,\n\
   ,    * . *     ,\n\
       * . . *      ,\n\
 ,    * .| |. *     \n\
     ****| |****   ,\n\
         | |      , \n\
-^-^^-^----^-^-^----^--\n\
";

곧 다가오는 크리스마스에 대비해서, 눈오는 날의 나무를 만들어보았다.

RobotomyRequestForm은 로봇화의 성공률이 50퍼센트가 되도록 멤버 함수를 만들어주어야 한다. 이 때, 성공률은 시간의 50%라고 되어있으므로, 현재 시각을 불러와서 2로 나누었을 때의 나머지를 통해 성공과 실패를 나누어 주었다.

void RobotomyRequestForm::execute(const Bureaucrat &bureaucrat) const {
  this->isExecutable(bureaucrat);
  std::cout << "Drilling....." << std::endl;
  std::time_t currentTime = std::time(nullptr);
  (currentTime % 2 == 0)
    ? std::cout << this->_target << " has been robotomized successful." << std::endl
    : std::cout << this->_target << " has failed to robotomize." << std::endl;
}

시간은 <ctime> 라이브러리에서 std::time_t 객체의 time 함수를 통해 구할 수 있다. 이때 반환되는 시간은 흔히 유닉스시간(혹은 Epoch 시간) 이라고 하는 시간이 반환된다. 우리는 어차피 초단위만 사용하면 되기때문에 반환 받은 값을 별다른 변환 없이 2로 나누어 주기만 하면 된다.

General Concepts

마지막으로 PresidentialPardonForm은 가장 쉽다. 그냥 등급에 맞는지 확인하고, 맞다면 적절한 메세지를 출력하면 된다.

Ex03

문제

우리의 양식들을 채우는것이 충분히 화가나기 때문에, 우리 관료들에게 하루 종일 이걸 하라고 하는것은 잔인할 것이다. 운좋게도, 인턴이 존재한다. 이번 예제에서는 인턴클래스를 구현해야한다. 인턴은 이름도 등급도 고유한 특성도 가지고 있지 않다. 관료들이 신경쓰는 유일한 것은 그들이 일을 하는것이다.

그러나, 인턴은 makeForm 함수라는 중요한 것을 하나 가진다. 이것은 두개의 문자열이 필요하다. 첫 문자열은 양식의 이름이고, 두번째는 양식의 타겟 이름이다. 이것은 두번째 인자로 초기화될 양식 객체(이름은 매개변수로 전달된 이름이다.)에 대한 포인터를 반환한다.

다음과 같이 출력될 것이다.

Intern creates <form>

만약 양식 이름이 인자로써 존재하지 않는다면, 명시적인 에러 메세지를 출력해야한다.

너는 if/elseif/else 숲처럼 가독성이 떨어지고 못생긴 해법을 피해야만 한다. 이것들은 평가 과정에서 허용되지 않는다. 너는 더이상 피신 속에 있지 않다. 평소와 같이, 모든것이 예상대로 동작하는지 테스트를 해야한다.

예를 들어, 다음 코드는 "Bender" 라는 타겟으로 RobotomyRequestForm을 생성한다.

{
  Intern someRandomIntern;
  Form* rrf;

  rrf = someRandomIntern.makeForm("robotomy request", "Bender");
}

구현

인턴 클래스의 구현은 굉장히 쉬웠다. 일단, 이름, 등급, 등등의 것들이 존재하지 않는다는 언급이 클래스에서 변수를 가지고 있지 않다고 해석했고, 따라서 기본 OCCF 형식의 클래스로만 만들고난 뒤, 구현을 따로 해주지 않았다.

makeForm 멤버 함수를 만들어주기만 하면 되었는데, module 01의 ex06에서 사용했던 switch-case 문으로 if/elseif/else의 사용 없이 문제를 해결할 수 있었다.

인턴을 통해 AForm 형식을 반환받도록 구현하면 되기 때문에, 테스트는 ex02에서 사용했던 테스트를 변형하는 형식으로 확인해볼 수 있었다.

느낀 점

이번 과제는 예외처리에 대해 조금 더 명확한 예외 처리를 해보는 것을 요구하는 과제였는데, try-catch문을 처음 사용해보는 것은 아니어서 해볼만 했다. 하지만, 귀찮다는 이유로 혹은 norminette나 과제의 요구 사항을 이유로 사실 잘 사용하지 않았었는데, 이번 과제를 계기로 사용 빈도를 늘릴 수 있도록 노력 할 것이다. 확실히 더 가독성 있는 코딩과 유지보수 측면에서 조건문을 통한 예외처리보다 더 낫다는 장점이 있기 때문에 안할 이유 또한 없다.