メインコンテンツへスキップ
見出し画像

今日のコーディング:unexpand〜スペースをタブに変換〜

     毎回、C言語やC++によるUNIXコマンドなどの作成方法を紹介します。
     今回は、ファイルの空白(スペース)をタブに変換する unexpand コマンドです。スペースをタブに変換します。ソースコードを他の環境からエディタにコピー&ペーストしてタブコードを再現したい場合に便利です。オリジナルのマニュアルは次の通りです。

     unexpand コマンドのソースは、GNU coreutilsに含まれています。

     では、エッセンスだけの互換プログラムの実装例を次に示します。

    リスト1.unexpand の互換プログラムの実装例

    #include <stdio.h>
    #include <stdlib.h>
    
    #define FALSE 0
    #define TRUE  (! FALSE)
    
    //=====================================================
    // 型定義:
    //=====================================================
    typedef unsigned short  us;
    
    //=====================================================
    // 型定義:
    //=====================================================
    enum OPT_TYPE {
      OPT_DEBUG = 1 << 0, // デバッグスイッチ
      OPT_SIZE  = 1 << 1, // TABサイズ指定
      OPT_ALL   = 1 << 2  // 全空白を変換対象とする
    };
    
    //=====================================================
    // グローバル変数:
    //=====================================================
    const int MAX_FILES = 10;           // 最大ファイル数
    const char* DbgPrmpt = "debug >> "; // デバッグサイン
    
    //=====================================================
    // 関数:bin
    // 数値 c を size 桁の2進数で出力する
    //=====================================================
    int bin(int c, int size)
    {
      for(int i=0; i<size; i++){
        if(i && i % 8 == 0)
          printf(".");
        printf("%d"
               , (us)(1 << (size - i - 1)) & (us)c ? 1 : 0);
      }
      return 0;
    }
    
    //=====================================================
    // 関数:myexpand
    // ファイル fp 中の TAB コードを size 桁で変換する
    //=====================================================
    void myunexpand(FILE* fp, int size, int flag)
    {
      int c;
      int n = 0;
      int d, od;
      int istop = TRUE;
      int inword = FALSE;
      
      while((c = fgetc(fp)) != EOF){
        if(((flag & OPT_ALL) || !inword) && c == ' '){
          if(istop){
            od = d = size - (n % size);
            istop = FALSE;
          }
          else
            d--;
    
          /* printf("[%d]", d); */
          if(d % size == 1){
            putchar('\t');
            n += od;
            istop = TRUE;
          }
        }
        else {
          putchar(c);
          if(c == '\n'){
            n = 0;
            istop = TRUE;
            inword = FALSE;
          }
          else {
            n++;
            inword = TRUE;
          }
        }
      }
    }
    
    //=====================================================
    // 関数:main
    //=====================================================
    int main(int argc, char** argv)
    {
      int   is1st = TRUE;
      int   flag  = 0;         // コマンドライン・オプションの状態
      int   size  = 8;         // TABサイズ
      int   isfile[MAX_FILES]; // ファイルの引数番号
      int   fnum = 0;          // 指定されたファイル数
      FILE* fp = stdin;        // ファイルポインタ
    
      // コマンドライン・オプション解析
      for(int i=1; i < argc; i++){
        if(argv[i][0] == '-' && argv[i][1]){
          switch(argv[i][1]){
          case 'd':
            flag |= OPT_DEBUG;
            break;
          case 't':
            flag |= OPT_SIZE | OPT_ALL;
            size = atoi(argv[++i]);
            break;
          case 'a':
            flag |= OPT_ALL;
            break;
          }
        }
        else {
          // ファイルが指定された引数位置を記憶
          if(fnum < MAX_FILES)
            isfile[fnum++] = i;
          else
            printf("Error: overflow files.\n");
        }
      }
    
      // ファイル処理の実行
      for(int i=0; i < fnum; i++){
        if(flag & OPT_DEBUG){
          printf("%s"
                 "option:["
                 , DbgPrmpt);
          bin(flag, 8);
          printf("]\n");
          printf("%s"
                 "file:[%s]\n"
                 , DbgPrmpt, argv[isfile[i]]);
        }
    
        if(is1st){
          is1st = FALSE;
        }
        else {
          /* putchar('\n'); */
        }
        /* printf("==> %s <==\n", argv[i]); */
    
        // ファイル名が有効ならファイルオープン、
        // そうでなければ標準入力とする
        fp = argv[isfile[i]][0] != '-' ? fopen(argv[isfile[i]], "r") : stdin;
        if(! fp){
          perror(argv[0]);
        }
        else {
          myunexpand(fp, size, flag);
    
          if(fp && fp != stdin)
            fclose(fp);
        }
      }
      
      if(is1st)
        myunexpand(fp, size, flag);
    
      return 0;
    }

     リスト1では、コマンドラインのオプション解析を完了してから処理を進めるようにしています。オプションおよびオプションの引数から、指定状態をflagに集約し、-t の引数となるタブサイズを size に取り出しています。また、ファイルとみなせるコマンドライン・オプションの位置を isfile[] に追加登録し、発見したファイル数を fnum でカウントしています。念のため、ファイルのオープンエラーも入れています。対応しているオプションは -i と -t ですが、-t の個別のタブセットには未対応です。
     オリジナルのプログラム(coreutils-9.7)は、ファイル unexpand.cの他に、 expand コマンドで使った2ファイル expand-common.h, expand-common.c も使っているようです。これらのサイズ合計は 799 文字、関数名のリストは次の通りです。リスト1に示したプログラムは 161 文字なので、オリジナルに比べると機能不足でしょう。

    $grep "^[a-z|_].* (" expand-common.c unexpand.c | nl
         1	expand-common.c:add_tab_stop (colno tabval)
         2	expand-common.c:set_extend_size (colno tabval)
         3	expand-common.c:set_increment_size (colno tabval)
         4	expand-common.c:parse_tab_stops (char const *stops)
         5	expand-common.c:validate_tab_stops (colno const *tabs, idx_t entries)
         6	expand-common.c:finalize_tab_stops (void)
         7	expand-common.c:get_next_tab_column (colno column, idx_t *tab_index, bool *last_tab)
         8	expand-common.c:set_file_list (char **list)
         9	expand-common.c:next_file (FILE *fp)
        10	expand-common.c:cleanup_file_list_stdin (void)
        11	expand-common.c:emit_tab_list_info (void)
        12	unexpand.c:usage (int status)
        13	unexpand.c:unexpand (void)
        14	unexpand.c:main (int argc, char **argv)
    $

      さらに興味のある方はソースを参照してみると良いでしょう。

     前回は expand コマンドの互換プログラムの実装例を紹介しました。今回が unexpand コマンドなので、ほぼ内容が重複しています。文字列処理としては逆変換の関係にあります。これまでのところ、この記事の一連のシリーズでは、GNU coreutilsに含まれるコマンドを題材にしています。
     UNIXの発想では、単純なプログラムを組み合わせて様々な処理に活用することを推奨しているようです。こうした発想が存在しているということを踏まえるだけで良いかと思います。OSS(Open Source Software)の世界は自由です。みなさん自身ですべてを自由に選んでください。

     次回をお楽しみに。
     では、また。

     
     
    ノマドの口笛です。noteを始めてから1年が過ぎました。コンピュータにまつわる話、プログラミングの話など気の向くままに書いています。難しくない記事を書きたいと試行錯誤の日々です。食べ歩きや読書や動画鑑賞などが趣味です。こちらも記事にできれば幸いです。よろしくお願いします。

    あなたへのおすすめ