File: support_routines.adb

package info (click to toggle)
music123 15-0.1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 748 kB
  • ctags: 8
  • sloc: ada: 1,149; makefile: 70; sh: 8
file content (359 lines) | stat: -rw-r--r-- 13,334 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
with Ada.Text_IO; use Ada.Text_IO;
with Ada.Characters.Latin_1;
with Ada.Command_Line.Environment; use Ada.Command_Line.Environment;
with Ada.Numerics.Float_Random; use Ada.Numerics.Float_Random;
with Ada.Calendar; use Ada.Calendar;
with Ada.Strings.Fixed;

with GNAT.IO_Aux; use GNAT.IO_Aux;
with GNAT.OS_Lib; use GNAT.OS_Lib;
with GNAT.Directory_Operations; use GNAT.Directory_Operations;

with Intl; use Intl;
with Interfaces.C;

package body Support_Routines is

   function Format_String (Format : String; Insert : String) return String is
   begin
      for I in Format'First .. Format'Last - 1 loop
         if Format (I) = '%' and then Format (I + 1) = 'd' then
            return Format (Format'First .. I - 1) & Insert & Format (I + 2 .. Format'Last);
         end if;
      end loop;
      return Format; --  XXX Raise exception instead???
   end Format_String;

   procedure Error (Error_String : String) is
   begin
      Put (Standard_Error, N ("music123: ") & Error_String);
      New_Line (Standard_Error);
      Put (Standard_Error, To_String (Version));
      New_Line (Standard_Error);
      Put (Standard_Error, N ("usage: music123 [-hqrvz] files ..."));
      New_Line (Standard_Error);
      Put (Standard_Error, N ("-h     This help"));
      New_Line (Standard_Error);
      Put (Standard_Error, N ("-q     Run quiet"));
      New_Line (Standard_Error);
      Put (Standard_Error, N ("-r     Recurse over directories"));
      New_Line (Standard_Error);
      Put (Standard_Error, N ("-v     Print the version and exit"));
      New_Line (Standard_Error);
      Put (Standard_Error, N ("-z     Randomize the filelist"));
      New_Line (Standard_Error);
      New_Line (Standard_Error);
      Put (Standard_Error, N ("See the manpage for more options."));
      New_Line (Standard_Error);
   end Error;

   No_Home_Directory : exception;

   function Home_Directory return String is
   begin
      for I in 1 .. Environment_Count loop
         declare
            E : String := Environment_Value (I);
         begin
            if E (E'First .. E'First + 4) = "HOME=" then
               return (E  (E'First + 5 .. E'Last));
            end if;
         end;
      end loop;
      raise No_Home_Directory;
   end Home_Directory;

   function Is_Whitespace (C : Character) return Boolean is
   begin
      return (C = ' ') or else (C = Ada.Characters.Latin_1.HT);
   end Is_Whitespace;

   procedure Import_Conffile (Program_List : out Tool_List.Vector)
   is
      Conf_File : File_Type;
      Pointer_Start, Pointer_End : Natural;
   begin
      Program_List := New_Vector;
      begin
         Open (Conf_File, In_File, Home_Directory & "/.music123rc");
         goto Conf_File_Open;
      exception
         when others =>
            null;
      end;
      begin
         Open (Conf_File, In_File, "/etc/music123rc");
      exception
         when others =>
            Error (N ("Neither /etc/music123rc or ~/.music123 found. Exiting."));
            raise Noted_Error;
      end;
      <<Conf_File_Open>> null;
      while (not End_Of_File (Conf_File)) loop
         declare
            Line : String := GNAT.IO_Aux.Get_Line (Conf_File);
            This_Tool : Tool;
         begin
            if Line'Length > 4 and then Line (Line'First .. Line'First + 3) = "tool" then
               Pointer_Start := Line'First + 4;
               while Is_Whitespace (Line (Pointer_Start)) loop
                  Pointer_Start := Pointer_Start + 1;
               end loop;
               Pointer_End := Pointer_Start;
               while not Is_Whitespace (Line (Pointer_End + 1)) loop
                  Pointer_End := Pointer_End + 1;
               end loop;
               This_Tool.Program := To_Unbounded_String (Line (Pointer_Start .. Pointer_End));
               Pointer_Start := Pointer_End + 1;
               while Is_Whitespace (Line (Pointer_Start)) loop
                  Pointer_Start := Pointer_Start + 1;
               end loop;
               Pointer_End := Pointer_Start;
               while not Is_Whitespace (Line (Pointer_End + 1)) loop
                  Pointer_End := Pointer_End + 1;
               end loop;
               This_Tool.Extension_List := To_Unbounded_String (Line (Pointer_Start .. Pointer_End));
               Pointer_Start := Pointer_End + 1;
               while (Line (Pointer_Start) /= '"') loop -- " -- This is legal, no matter what emacs says!
                  Pointer_Start := Pointer_Start + 1;
               end loop;
               Pointer_Start := Pointer_Start + 1;
               Pointer_End := Pointer_Start;
               while (Line (Pointer_End) /= '"') loop -- " -- Once again!
                  Pointer_End := Pointer_End + 1;
               end loop;
               Pointer_End := Pointer_End - 1;
               This_Tool.Options := To_Unbounded_String (Line (Pointer_Start .. Pointer_End));
               Append (Program_List, This_Tool);
            end if;
         end;
      end loop;
      Close (Conf_File);
   end Import_Conffile;

   Null_Tool : constant Tool := (To_Unbounded_String ("/dev/null"), Null_Unbounded_String, Null_Unbounded_String);

   function Matched_Extension (Extension_List : in Tool_List.Vector; Filename : String) return Tool is
      Pointer_Start, Pointer_End : Natural;
   begin
      for I in 1 .. Length (Extension_List) loop
         declare
            Ext_List : String := To_String (Get (Extension_List, I).Extension_List);
         begin
            Pointer_Start := Ext_List'First;
            Pointer_End := Ext_List'First;
            while Pointer_End < Ext_List'Last loop

               while Pointer_End /= Ext_List'Last and then Ext_List (Pointer_End + 1) /= ',' loop
                  Pointer_End := Pointer_End + 1;
               end loop;
               if Filename'Length > Pointer_End - Pointer_Start + 1 and then
                 (Filename (Filename'Last + Pointer_Start - Pointer_End - 1 .. Filename'Last) =
                  "." & Ext_List (Pointer_Start .. Pointer_End)) then
                  return Get (Extension_List, I);
               end if;
               Pointer_Start := Pointer_End + 2;
               Pointer_End := Pointer_Start;

            end loop;
         end;
      end loop;
      return Null_Tool;

   end Matched_Extension;

   function Check_Filename (Full_Name : String; Extension_List : Tool_List.Vector) return Boolean is
   begin
      return Is_Directory (Full_Name) or else
        Matched_Extension (Extension_List, Full_Name) /= Null_Tool;
   end Check_Filename;

   procedure Expand_And_Check_Filenames
     (File_List : in out UString_List.Vector;
      Option_Recurse : in Boolean;
      Extension_List : in Tool_List.Vector
     )
   is
      Current_Directory : Dir_Type;
      I : Integer;
      Directory_Entry : String (1 .. 4096);
      -- 4096 is more than FILENAME_MAX on glibc 2.1 for Linux/i386.
      -- The internal implementation of Read (Dir) only does 1024
      -- on the same platform, but this makes us safe even if they
      -- change that. Bash wouldn't create a file name longer then
      -- 255, so it shouldn't usually be a problem.
      Filename_Length : Natural;
   begin
      if Empty (Extension_List) then
         Error (N ("The config file (~/.music123 or /etc/music123rc) is corrupt."));
         raise Noted_Error;
      end if;
      I := 1;
      while I <= Length (File_List) loop
         declare
            Current_File : String := To_String (Get (File_List, I));
         begin
            if not File_Exists (Current_File) then
               Remove (File_List, I);
               I := I - 1;
            elsif Is_Directory (Current_File) then
               begin
                  Remove (File_List, I);
                  I := I - 1;
                  if Option_Recurse then
                     Open (Current_Directory, Current_File);
                     Filename_Length := 1;
                     while (Filename_Length /= 0) loop
                        Read (Current_Directory, Directory_Entry, Filename_Length);
                        if Filename_Length /= 0 and then
                          (Filename_Length /= 1 or else Directory_Entry (1) /= '.') and then
                          (Filename_Length /= 2 or else Directory_Entry (1 .. 2) /= "..") then
                           declare
                              Full_Name : String := Current_File & "/" & Directory_Entry (1 .. Filename_Length);
                           begin
                              --  Adding, then removing the file was creating a O(N^2) result. Check it first.
                              if Check_Filename (Full_Name, Extension_List) then
                                 Append (File_List, To_Unbounded_String (Full_Name));
                              end if;
                           end;
                        end if;
                     end loop;
                     Close (Current_Directory);
                  end if;
               exception
                  when Directory_Error =>
                     null;
               end;
            end if;
            I := I + 1;
         end;
      end loop;
      if Empty (File_List) then
         Error (N ("No valid filenames found."));
         raise Noted_Error;
      end if;

   end Expand_And_Check_Filenames;

   procedure Randomize_Names (File_List : in out UString_List.Vector) is

      A, B : Unbounded_String;
      J : UString_List.Index;
      Gen : Generator;
      Len : Integer := Length (File_List);
   begin
      Reset (Gen, Integer (Seconds (Clock) * 10.0));
      -- From Knuth, TAOCP vol. 2, edition 3, page 146, 3.4.2, algorithm P
      for I in reverse 2 .. Len loop
         J := Integer (Float'Floor (Random (Gen) * Float (I))) + 1;
         A := Get (File_List, I);
         B := Get (File_List, J);
         Set (File_List, I, B);
         Set (File_List, J, A);
      end loop;
   end Randomize_Names;

   function Shell_Fix (File : String) return String is
   begin
      if File'Length = 1 then
         if File = "'" then
            return "'""'""'";
         else
            return File;
         end if;
      elsif File (File'First) = ''' then
         return "'""'""'" & Shell_Fix (File (File'First + 1 .. File'Last));
      else
         return File (File'First) & Shell_Fix (File (File'First + 1 .. File'Last));
      end if;
   end Shell_Fix;

   procedure Play_Songs
     (File_List : in out UString_List.Vector;
      Program_List : in Tool_List.Vector;
      Delay_Length : in Duration;
      Option_Quiet : in Boolean;
      Option_Loop : in Boolean;
      Option_Random : in Boolean;
      Option_Eternal_Random : in Boolean
     ) is

      Gen : Generator;
      Len : Integer;
      J : UString_List.Index;

      use Interfaces.C;
      function System (Command : Char_Array) return Integer;
      pragma Import (C, System, "system");

      procedure Play_A_Song (File_Name : in String; Option_Quiet : in Boolean) is
         System_Result : Integer;
         This_Program : Tool;
      begin
         This_Program := Matched_Extension (Program_List, File_Name);
         if Option_Quiet then
            declare
               System_String : String := To_String (This_Program.Program & " " & This_Program.Options & " '" &
                                                    Shell_Fix (File_Name) & "'" & ">/dev/null 2>/dev/null");
            begin
               System_Result := System (To_C (System_String));
            end;
         else
            declare
               System_String : String :=  To_String (This_Program.Program & " " & This_Program.Options & " '" &
                                                     Shell_Fix (File_Name) & "'");
            begin
               System_Result := System (To_C (System_String));
            end;
         end if;
      end Play_A_Song;

   begin
      if Option_Eternal_Random then
         Len := Length (File_List);
         Reset (Gen, Integer (Seconds (Clock) * 10.0));
      end if;

      if Option_Random then
         Randomize_Names (File_List);
      end if;

      <<Loop_Start>> null;
      for I in 1 .. Length (File_List) loop
         if Option_Eternal_Random then
            J := Integer (Float'Floor (Random (Gen) * Float (I))) + 1;
            Play_A_Song (To_String (Get (File_List, J)), Option_Quiet);
         else
            Play_A_Song (To_String (Get (File_List, I)), Option_Quiet);
         end if;
         delay (Delay_Length);
      end loop;
      if Option_Loop or else Option_Eternal_Random then
         goto Loop_Start;
      end if;
   end Play_Songs;

   procedure Read_Playlist (Full_Name : String; File_List : in out UString_List.Vector) is
      Playlist : File_Type;
   begin
      begin
         Open (Playlist, In_File, Full_Name);
      exception
         when others =>
            Error (N ("Playlist file not found."));
            raise Noted_Error;
      end;
      while (not End_Of_File (Playlist)) loop
         declare
            Line : String := Ada.Strings.Fixed.Trim (GNAT.IO_Aux.Get_Line (Playlist), Ada.Strings.Both);
         begin
            if Line /= "" and then Line (1) /= '#' then
               Append (File_List, To_Unbounded_String (Line));
            end if;
         end;
      end loop;
      Close (Playlist);
   end Read_Playlist;

 end Support_Routines;