/*
 * Volume Past Limit Sample
 */

// a link to the company website
#property link      ""
// the company name
#property copyright ""
// サブウィンドウ上に指標を表示する.
#property indicator_separate_window
// 表示する指標の数.
#property indicator_buffers 3
// 線の色
#property indicator_color1  Green
#property indicator_color2  Blue
#property indicator_color3  Red

/*
 * 外部変数.
 */
// output file name.
extern string OUTPUT_FILE_NAME = "SampleVolumePastLimit.log";
// Timeframes.
extern int TIMEFRAME = PERIOD_H1;      // Timeframe used on the chart.
// MA Period.
extern int PERIOD = 21;
// debug
extern bool DEBUG = false;

// 表示用のバッファ.
double BUFFER_VOLUME[];
double BUFFER_HIGH[];
double BUFFER_LOW[];

/*
 * 初期化処理.
 * チャートを表示するときに実行する.
 */
int init() {
    output("start 'init' function");

    // volume
    SetIndexBuffer(0, BUFFER_VOLUME);
    SetIndexLabel(0, "volume");
    // highest
    SetIndexBuffer(1, BUFFER_HIGH);
    SetIndexLabel(1, "volume highest");
    // lowest
    SetIndexBuffer(2, BUFFER_LOW);
    SetIndexLabel(2, "volume lowest");

    output("finish 'init' function");
    return(0);
}
 
/*
 * 後処理.
 * チャートから削除するときに実行する.
 */
int deinit() {
    output("start 'deinit' function");
    output("finish 'deinit' function");
    return(0);
}

/*
 * 基本処理.
 * 次の tick が決まるたびに実行する. 
 */
int start() {
    output("start 'start' function");
    int countingBars = getCountingBars();
    string message;
    datetime currentPeriodTime;
    int specifiedPeriodIndex;
    // 過去から現在に向かってバーのインデックスを移動する.  
    for (int i = countingBars - 1; i >= 0; i--) {
        currentPeriodTime = currentPeriodIndex2Time(i);
        specifiedPeriodIndex = time2SpecifiedPeriodIndex(currentPeriodTime);
        // 出来高を指標バッファに設定する
        BUFFER_VOLUME[i] = getVolume(specifiedPeriodIndex);
        // 一定期間内の出来高の中で高値を指標バッファに設定する
        BUFFER_HIGH[i] = getVolumeHighest(specifiedPeriodIndex);
        // 一定期間内の出来高の中で安値を指標バッファに設定する
        BUFFER_LOW[i] = getVolumeLowest(specifiedPeriodIndex);

        message = createMessage(i, BUFFER_VOLUME[i]);
        output(message);
        message = createMessage(i, BUFFER_HIGH[i]);
        output(message);
        message = createMessage(i, BUFFER_LOW[i]);
        output(message);
    }
    output("finish 'start' function");
    return(0);
}

/*
 * 指定したインデックスの出来高を返す.
 */
double getVolume(int index) {
    double volume = iVolume(
            Symbol(),       // 通貨ペア名
            TIMEFRAME,      // 時間枠
            index);
    return(volume);
}
/**
 * 一定期間内の出来高の中で高値を返す.
 */
double getVolumeHighest(int index) {
	double high = getVolume(index);
	double current;
    for (int i = index + 1; i < index + PERIOD; i++) {
        current = getVolume(i);
        if (high < current) {
        	high = current;
        }
    }
    return(high);
}
/**
 * 一定期間内の出来高の中で安値を返す.
 */
double getVolumeLowest(int index) {
    double low = getVolume(index);
    double current;
    for (int i = index + 1; i < index + PERIOD; i++) {
        current = getVolume(i);
        if (low > current) {
            low = current;
        }
    }
    return(low);
}

/*
 * 現在の時間枠でのインデックスから対応する時刻を返す.
 */
datetime currentPeriodIndex2Time(int index) {
    datetime currentTime = iTime(Symbol(), 0, index);
    string currentTimeString = datetime2String(currentTime);
    string message = StringConcatenate(
        "current period time:",
        currentTimeString);
    output(message);
    return(currentTime);
}

/*
 * 指定した時刻、時間枠からインデックスを返す.
 */
int time2SpecifiedPeriodIndex(datetime time) {
    int index = iBarShift(
           Symbol(),           // Symbol the data of which should be used to calculate indicator. NULL means the current symbol.
           TIMEFRAME,          // Timeframe. It can be any of Timeframe enumeration values. 0 means the current chart timeframe.
           time,               // value to find (bar's open time).
           false);             // Return mode when bar not found. false - iBarShift returns nearest. true - iBarShift returns -1.
    datetime specifiedPeriodTime = iTime(Symbol(), TIMEFRAME, index);
    string message = StringConcatenate(
        "specified period time:",
        datetime2String(specifiedPeriodTime));
    output(message);
    return(index);
}
        
/*
 * メッセージを作る.
 * format
 *      symbol, datetime, price
 */
string createMessage(int index, double price) {
    string symbolString = Symbol();
    string datetimeString = datetime2String(
            iTime(symbolString, 0, index));
    string priceString = DoubleToStr(
            price,
            Digits);
    string message = StringConcatenate(
            symbolString,
            ",",
            datetimeString,
            ",",
            priceString);
    return(message);
}
/*
 * 日時から文字列に変換する
 */
string datetime2String(datetime dt) {
    string value = TimeToStr(dt, TIME_DATE | TIME_SECONDS);
    return(value);
}                
/*
 * ファイルに出力する.
 */
void output(string message) {
    if (!DEBUG) {
        return;
    }
    int handle = openFile();    
    if (handle == -1) {
        return;
    }
    writeFile(handle, "info", message);
    closeFile(handle);
}

/*
 * 今回計算するバーの数を返す.
 */
int getCountingBars() {
   // チャート上のバーの数.
    int bars = Bars;
    // 変化のなかったバーの数.
    int countedBars = IndicatorCounted();
    if (countedBars < 0) {
        return(0);
    }
    // 今回計算するバーの数.
    int countingBars = bars - countedBars - 1;
    return(countingBars);
}

/*
 * ファイルを開く.
 * return file handle.
 *      not -1 : opened file
 *      -1     : fail
 */
int openFile() {
    int handle = FileOpen(OUTPUT_FILE_NAME, FILE_CSV|FILE_READ|FILE_WRITE, ",");
    if (handle != -1) {
        FileSeek(handle, 0, SEEK_END);
    } else {
        int errorCode = GetLastError();
        Print("Cannot open file. [name:", OUTPUT_FILE_NAME, "][errorCode:", errorCode, "]");
    }
    return(handle);
}

/*
 * ファイルを閉じる.
 */
void closeFile(int handle) {
    FileClose(handle);
}

/*
 * ファイルに文字列を書く.
 */
void writeFile(int handle, string typeName, string message) {
    datetime current = TimeCurrent();
    int result = FileWrite(
           handle,
           datetime2String(current),
           typeName,
           message);
    if (result >= 0) {
        FileFlush(handle);
        return;
    }
    
    int errorCode = GetLastError();
    Print("Cannot write file. [name:", OUTPUT_FILE_NAME, "][errorCode:", errorCode, "]");
    return; 
}