Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CNative::Clear の実装を改善 #777

Merged
merged 6 commits into from
Feb 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sakura_core/basis/CStrictInteger.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
#ifndef SAKURA_CSTRICTINTEGER_6F202774_0F82_4BB7_B107_37DE5443309E_H_
#define SAKURA_CSTRICTINTEGER_6F202774_0F82_4BB7_B107_37DE5443309E_H_

#include "primitive.h" // for Int

//int以外の整数型もintにキャストして扱う
#define STRICTINT_OTHER_TYPE_AS_INT(TYPE) \
Me& operator += (TYPE rhs) { return operator += ((int)rhs); } \
Expand Down
1 change: 1 addition & 0 deletions sakura_core/basis/SakuraBasis.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@

#else
// -- -- 通常のintで単位型を定義
#include "primitive.h" // for Int

//ロジック単位
typedef int CLogicInt;
Expand Down
2 changes: 1 addition & 1 deletion sakura_core/mem/CNative.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
//! 空っぽにする
void CNative::Clear()
{
this->SetRawData("",0);
this->_GetMemory()->_SetRawLength(0);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#776 (comment) の指摘は、
this->SetRawData("",0); が「意図通りに動くか不安」という意味でした。

sizeof("") は 1byte になります。
0byte のメモリを確保したところに 1byte のデータをコピーして大丈夫なんでしたっけ?という不安です。

いまコードを追って確認してみた感じ、大丈夫そうでした。

SetRawDataは一度内部バッファを開放したあと、
引数で指定されたサイズ + 2を算出し、
確保サイズが8バイト単位になるように調整してからallocします。
指定サイズが 0 だった場合は 8byte 確保されます。

(0 + 2 + 7) & (~7)
= 9 & (~7)
= 0x09 & (0xF8) ← 2進表記で 00001001 & 11111000
= 0x08

+2 は wchar_t のNUL終端を意識した処理、
8バイト整列はCPUのフェッチ単位を意識した処理と思われます。
(もしそうなら確保サイズだけ気にしても意味無いんですがw)

なので、CNativeT::Clear()の処理を変える必要はないと思います。
「この処理は安全です!」というコメントを入れとく意味はあると思います。
そういうコメントがあっても「ほんとに?」と思ってしまうのがプログラマのサガではありますが。

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SetRawDataは一度内部バッファを開放したあと、
引数で指定されたサイズ + 2を算出し、
確保サイズが8バイト単位になるように調整してからallocします。
指定サイズが 0 だった場合は 8byte 確保されます。

データサイズをクリアすればよく、データのバッファを解放する
必要はないと思っています。

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

単にCNativeTのデータをクリアする・空っぽにする

と言った場合、その詳細には「余分なメモリの開放」が含まれると思います。
もっと高級言語なら実際のバッファがどうなってるかなんて意識しませんが、
c++ではそのあたりの詳細も考えるべきことの一つになります。

CMemoryのメモリ再確保はサイズ拡大の場合だけになっています。

CNative::Clear()の実装から「余分なメモリの開放」を外すと
メモリ解放するタイミングがデストラクト時だけになってしまいます。

なので、外すにしても「余分なメモリの開放」を行う関数を用意する必要があると思います。

どちらかというと、「余分なメモリの開放」が不要であればこの関数を呼ばない、で切り抜けるのがよいと思います。

}
92 changes: 92 additions & 0 deletions tests/unittests/test-cnative.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
/*! @file */
/*
Copyright (C) 2018-2019 Sakura Editor Organization

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented;
you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment
in the product documentation would be appreciated but is
not required.

2. Altered source versions must be plainly marked as such,
and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.
*/
#include <gtest/gtest.h>
#include "mem/CNativeW.h"
#include "mem/CNativeA.h"

/*!
CNativeW::Clear のデータサイズのクリアをテストする

1-1. 固定データを追加する
1-2. バッファの状態を取得する
1-3. バッファの状態をチェックする

2-1. CNativeW をクリアする
2-2. クリア後のバッファの状態を取得する
2-3. クリア後のバッファの状態をチェックする

3-1. 固定データを再追加する
3-2. バッファの状態を取得する
3-3. バッファの状態をチェックする
*/
TEST(CNativeW, Clear)
{
constexpr const WCHAR* fixedPatternStr = L"abc";
constexpr const int fixedPatternLen = 3;

CNativeW stringW;

// 1-1. 固定データを追加する

stringW.AppendString(fixedPatternStr); // 固定データを追加する

// 1-2. バッファの状態を取得する

auto orgCapacity = stringW.capacity(); // データ追加後にバッファサイズを取得する
auto orgLength = stringW.GetStringLength(); // Clear() 前にデータサイズを取得する

// 1-3. バッファの状態をチェックする

EXPECT_GT(orgCapacity, 0); // データ追加後のバッファサイズを確認する
EXPECT_EQ(orgLength, fixedPatternLen); // データ追加後のデータサイズを確認する

// 2-1. CNativeW をクリアする

stringW.Clear(); // CNativeW をクリアする

// 2-2. クリア後のバッファの状態を取得する

auto newCapacity = stringW.capacity(); // Clear() 後にバッファサイズを取得する
auto newLength = stringW.GetStringLength(); // Clear() 後にデータサイズを取得する

// 2-3. クリア後のバッファの状態をチェックする

EXPECT_EQ(orgCapacity, newCapacity); // Clear() 後にバッファサイズが変わっていないのを確認する
EXPECT_EQ(newLength, 0); // Clear() 後にデータが空なのを確認する

// 3-1. 固定データを再追加する

stringW.AppendString(fixedPatternStr); // Clear() 後に固定データを再追加する

// 3-2. バッファの状態を取得する

auto newCapacity2 = stringW.capacity(); // 再追加後にバッファサイズを取得する
auto newLength2 = stringW.GetStringLength(); // 再追加後にデータサイズを取得する

// 3-3. バッファの状態をチェックする

EXPECT_EQ(orgCapacity, newCapacity2); // 再追加後にバッファサイズが変わっていないのを確認する
EXPECT_EQ(newLength2, fixedPatternLen); // 再追加後にデータサイズを確認する
}