Класс автоматического взведения и сброса флага

[SASA]

Код:

#ifndef FLAGASSISTANT_H
#define FLAGASSISTANT_H

/// Дефайн для быстрого взведения флага спомощью класса CFlagAssistant. 
#define COCKFLAG(flagName) CFlagAssistant flagAssistant(&flagName); 

/*!	\brief	Класс автоматического взведения и сброса флага.
*	\author SASA.
*	\date	2010/08/18
*/
class CFlagAssistant
{
public:
	/*!	\brief Конструктор.
	*	\param[in] _flag (\c bool *) - Указатель на флаг, за которым следим.
	*/
	CFlagAssistant(bool * _flag) 
	{
		m_flag = _flag; 
		if(m_flag) *m_flag = true; 
	}
	~CFlagAssistant()
	{ 
		if(m_flag) *m_flag = false; 
	}
protected:
	bool * m_flag; ///< Флаг за которым следим.
};

#endif // FLAGASSISTANT_H

Использование.

Код:

class MyClass
{
public:
	MyClass() 
	{
		m_flag = false;
	}
	/*!	Пока исполняется этот метод, флаг должен быть взведённым.
	*	После выхода из метода, флаг должен сброситься.
	*/
	void metod()
	{
		COCKFLAG(m_flag);
		много кода c несколькими ретурнами;
	}
protected:
	m_flag;
};

Самое главное, что изменив код метода (добавив ещё один ретурн) нам не надо писать строку m_flag = false; А про неё так легко забыть А есть ещё исключения, по которым функция может прерваться где угодно. Класс позволяет легко сохранить условие, описанное в комментарии.

З.Ы. О валидности указателя надо заботиться самим. Буду рад услышать предложения о повышении безопастности

[spectre71]

А если флаг был == true, что получится при выходе

И вообще интереснее установка флага в конкретное значение (true/false)

[SASA]

А если флаг был == true, что получится при выходе

И вообще интереснее установка флага в конкретное значение (true/false)

Что Вы имеете в виду.

[SABROG]

Что Вы имеете в виду.

Вероятно то, что у тебя нигде флаг не устанавливается в 0. Вроде как стандарт C++ инициализирует нулями только POD типы и не факт, что класс является POD типом.

[pastor]

... не факт, что класс является POD типом.

Данный класс (CFlagAssistant) точно не является POD типом.

[Denjs]

гм... можно "человеческими" словами описать за какой надобностью данный класс нужен?
ну т.е. бизнес-профит? бизнес-задача или системная задача которую решает данный класс? а то как-то я затрудныюсь понять зачем мне например данный класс может быть полезен? за каком флагом мы следим? зачем его быстро возводим? и т.п.... ?

UPD: через некоторое время разбора кода понял, что класс предназначен для "автоматического" сброса|устновки значения переменной по выходу из процедуры или участка кода в "{}"  - что бы не восстанавливать старое значение руками.
да?

гм... предлагаю рекомендовать дополнять "готовые решения" описанием бизнес-пригодности предлагаемых решений ... для чего они нужны и описание случаев когда они будут полезны. Код конечно иногда сам за себя говорит, но на разбор кода нужно время.

Заранее спасибо.

[SASA]

да?

Да.
По-моему я всё опсиал. Класс простенький - описание простенькое.

Логика работы аналогична QMutexLocker.

[Igors]

У меня есть такой же класс, называется CAutoFlag, (правда указатель но ноль я не проверяю). Штучка малюсенькая но удобная. Без нее получается коряво, напр.

Код

C++ (Qt)
void MyClass::CalcSomething( void )
{
 mPortalActive = true;
 if (!Check1()) {
  mPortalActive = false;
  return;
 } 
...
 if (!Check2()) {
  mPortalActive = false;
  return;
 } 
...
  mPortalActive = false;
}
 

С классом приятнее

Код

C++ (Qt)
void MyClass::CalcSomething( void )
{
 CAutoFlag theFlag(&mPortalActive);
 if (!Check1()) 
  return;
...
 if (!Check2()) 
  return;
...
}
 

[navrocky]

Обощим идею Пример использования в каментах ниже

Код

C++ (Qt)
#pragma once
 
/*! Use this scoped class to temporarely change some value and restore old value
    when scope out.
 
 \code
 bool block;
 {
     scoped_value_change<bool> s(block, true, block);
     ...
 }
 ...
 std::string status;
 {
     scoped_value_change<std::string> s(flag, "entered", "leaved");
     ...
 }
 
 \endcode
 */
template <typename T>
class scoped_value_change
{
public:
    scoped_value_change(T& value, const T& in, const T& out)
    : value_(value), out_(out)
    {
        value_ = in;
    }
 
    ~scoped_value_change()
    {
        value_ = out_;
    }
private:
    T& value_;
    T out_;
};
 

[spectre71]

А если флаг был == true, что получится при выходе

И вообще интереснее установка флага в конкретное значение (true/false)

Что Вы имеете в виду.

bool MyFlg1 = true;
bool MyFlg2 = false;

{
  COCKFLAG(MyFlg1);
  COCKFLAG(MyFlg2);

//MyFlg1 == true;
//MyFlg2 == true;
...
...

}

//MyFlg1 == false;
//MyFlg2 == false;


//MyFlg1 должен быть равен true !!!

[navrocky]

//MyFlg1 должен быть равен true !!!

В моем варианте это решено:

Код:

bool my_flag = true;
{
    scoped_value_change<bool> sv(my_flag, false, my_flag);
    // my_flag = false
}
// my_flag = true

[SASA]

Обощим идею

Мне нравится. Но я бы добавил макрос типа COCKFLAG.
Почему он нужен? Потому что две следущие строки очень похожи, а поведение прямо противоволожное.

Код:

scoped_value_change<bool> s(block, true, block);

Код:

scoped_value_change<bool>(block, true, block);

И по смыслу более логично. Я хочу написать строчку со смыслом "Взведи флаг, который автоматом сброситься". А не "Заведи переменную, которая мне потом не нужна, которая взведет флаг и потом его сбросит".

[Akon]

Обощим идею Пример использования в каментах ниже

Код

C++ (Qt)
#pragma once
 
/*! Use this scoped class to temporarely change some value and restore old value
    when scope out.
 
 \code
 bool block;
 {
     scoped_value_change<bool> s(block, true, block);
     ...
 }
 ...
 std::string status;
 {
     scoped_value_change<std::string> s(flag, "entered", "leaved");
     ...
 }
 
 \endcode
 */
template <typename T>
class scoped_value_change
{
public:
    scoped_value_change(T& value, const T& in, const T& out)
    : value_(value), out_(out)
    {
        value_ = in;
    }
 
    ~scoped_value_change()
    {
        value_ = out_;
    }
private:
    T& value_;
    T out_;
};
 

Более-менее окончательный вариант.
Я бы добавил еще простой конструктор (частный случай), оставляющий исходное значение:

Код:

scoped_value_change(T& value, const T& out)
: value_(value), out_(out)
{
}

Ну и оптимизация. Что лучше: 1) const T& out или 2) T out - зависит от Т. boost::call_traits<T>::param_type - будет передавать либо по ссылке, либо по значению (истинное обобщение  ).   

[navrocky]

Мне нравится. Но я бы добавил макрос типа COCKFLAG.

Согласен, на базе этого можно наплодить дефайнов, упрощающих часто используемые вызовы.

Я бы добавил еще простой конструктор (частный случай), оставляющий исходное значение:

Да!

boost::call_traits

Таки тоже да!

Результат:

Код

C++ (Qt)
#pragma once
 
#include <boost/call_traits.hpp>
 
/*! Use this scoped class to temporarely change some value and restore old value
    when scope out.
 
 \code
 bool flag;
 {
     scoped_value_change<bool> s(flag, true, flag);
     ...
     // or
     scoped_value_change<bool> s(flag, true);
     ...
 
     // or even
     SCOPE_COCK_FLAG(flag);
     ...
 }
 \endcode
 */
 
/*! Temporarely set a flag to true and return old flag value when the scope is out.*/
#define SCOPE_COCK_FLAG(flag) scoped_value_change<bool> __sv_##flag(flag, true)
 
/*! Temporarely set a flag to false and return old flag value when the scope is out.*/
#define SCOPE_RESET_FLAG(flag) scoped_value_change<bool> __sv_##flag(flag, false)
 
template <typename T>
class scoped_value_change
{
public:
    typedef typename boost::call_traits<T>::reference reference;
    typedef typename boost::call_traits<T>::param_type param;
 
    scoped_value_change(reference value, param in)
    : value_(value), out_(value)
    {
        value_ = in;
    }
 
    scoped_value_change(reference value, param in, param out)
    : value_(value), out_(out)
    {
        value_ = in;
    }
 
    ~scoped_value_change()
    {
        value_ = out_;
    }
private:
    reference value_;
    T out_;
};
 

[Авварон]

не ребят, у вас явно уже ум за разум заходит... больше буста