source: trunk/src/check_files.m

Last change on this file was 1093, checked in by g7moreau, 4 weeks ago
  • Update Copyright to 2021
File size: 11.5 KB
Line 
1%'check_files': check the path, modification date and svn version for all the
2%  function in the toolbox UVMAT. Called at the opening of uvmat. Adds the
3%  uvmat path to the Matlab path if needed.
4%----------------------------------------------------------------------
5% function [checkmsg,date_str,ver]=check_files
6%
7% OUTPUT:
8% checkmsg: error message listing functions whose paths are not in the directory of uvmat.m
9% date_str: date of the most recent modification of a file in the toolbox
10% ver : svn version in case this is a  svn repository
11
12%=======================================================================
13% Copyright 2008-2021, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
14%   http://www.legi.grenoble-inp.fr
15%   Joel.Sommeria - Joel.Sommeria (A) legi.cnrs.fr
16%
17%     This file is part of the toolbox UVMAT.
18%
19%     UVMAT is free software; you can redistribute it and/or modify
20%     it under the terms of the GNU General Public License as published
21%     by the Free Software Foundation; either version 2 of the license,
22%     or (at your option) any later version.
23%
24%     UVMAT is distributed in the hope that it will be useful,
25%     but WITHOUT ANY WARRANTY; without even the implied warranty of
26%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27%     GNU General Public License (see LICENSE.txt) for more details.
28%=======================================================================
29
30function [checkmsg,date_str,svn_info]=check_files
31checkmsg={};%default
32svn_info.rep_rev=[];
33svn_info.cur_rev=[];
34svn_info.status=[];
35list_fct={...
36    'activate';...% emulate the mouse selection of a GUI element, for demo
37    'browse_data';...% function for scanning directories in a project/campaign
38    'browse_data.fig';...% GUI corresponding to dataview
39    'calc_field_interp';...% defines fields (velocity, vort, div...) from civx data and calculate them
40    'calc_field_tps';...% defines fields (velocity, vort, div...) and calculate them
41    'cell2tab';... %transform a Matlab cell in a character array suitable for display in a table
42    'check_files';...
43    'compile';...% compile a Matlab function, create a binary in a subdirectory /bin
44    'copyfields';...% copy fields between two matlab structures
45    'create_grid';...% called by the GUI geometry_calib to create a physical grid
46    'create_grid.fig';...% GUI corresponding to create_grid.m
47    'dir_scan';... % scan the structure of the directory tree (for editxml.m)
48    'disp_uvmat';...% display a message using  msgbox_uvmat or on the log file in batch mode
49    'editxml';...% display and edit xml files using a xls schema
50    'editxml.fig';...% interface for editxml
51    'fileparts_uvmat';...% extracts the root name,field indexes and nomenclature type from an input filename
52    'fill_GUI';...%  fill a GUI with a set of parameters from a Matlab structure
53    'filter_tps';...% find the thin plate spline coefficients for interpolation-smoothing
54    'find_field_bounds';... % find the boounds and typical meshs of coordinates
55    'find_field_cells';...% group the variables of a 'field object' into 'field cells' and specify their structure
56    'find_file_series';...% check the content of an input file and find the corresponding file series
57    'find_imadoc';...% find the ImaDoc xml file associated with a given input file
58    'fullfile_uvmat';...% creates a file name from a root name and indices.
59    'geometry_calib';...% performs geometric calibration from a set of reference points
60    'geometry_calib.fig';...% interface for geometry_calib
61    'get_field';...% choose and plot a field from a Netcdf file
62    'get_field.fig';...%interface for get_field
63    'get_file_info';...% determine info about a file (image, multimage, civdata,...) .
64    'get_file_series';...% determine the list of file names and file indices for functions called by 'series'.
65    'hist_update';...%  update of a current global histogram by inclusion of a new field
66    'imadoc2struct';...%convert the image documentation file ImaDoc into a Matlab structure
67    'interp2_uvmat';...% linearly interpolate an image or scalar defined on a regular grid
68    'keyboard_callback';... % function activated when a key is pressed on the keyboard
69    'mask_proj';...% restrict input fields to a mask region, set to 0 outside
70    'mouse_down';% function activated when the mouse button is pressed on a figure (callback for 'WindowButtonDownFcn')
71    'mouse_motion';...% permanently called by mouse motion over a figure (callback for 'WindowButtonMotionFcn')
72    'mouse_up';... % function to be activated when the mouse button is released (callback for 'WindowButtonUpFcn')
73    'msgbox_uvmat';... % associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls
74    'msgbox_uvmat.fig';...
75    'nomtype2pair';... creates nomenclature for index pairs knowing the image nomenclature, used by series fct
76    'nc2struct';...% transform a netcdf file in a corresponding matlab structure
77    'num2stra';...% transform number to the corresponding character string depending on the nomenclature
78    'phys_XYZ';...% transform coordiantes from pixels to phys
79    'px_XYZ';...% transform coordiantes from phys to pixels
80    'plot_field';...%displays a vector field and/or scalar or images
81    'plot_object';...%draws a projection object (points, line, plane...)
82    'proj_field';...%project a field on a projection object (plane, line,...)
83    'read_civxdata';...reads civx data from netcdf files
84    'read_civdata';... reads new civ data from netcdf files
85    'read_field';...% read the fields from files in different formats (netcdf files, images, video)
86    'read_GUI';... %read a GUI and provide the data as a Matlab structure
87    'read_image';...%read images or video objects
88    'read_multimadoc';... %read a set of Imadoc files and compare their timing of different file series
89    'read_xls';...%read excel files containing the list of the experiments
90    'reinit';...% suppress the personal parameter file 'uvmat_perso.mat'
91    'rotate_points';...%'rotate_points': associated with GUI rotate_points.fig to introduce (2D) rotation parameters
92    'rotate_points.fig';...
93    'series';...% master function for analysis field series, with interface 'series.fig'
94    'series.fig';...% interface for 'series'
95    'set_col_vec';...% sets the color code for vectors depending on a scalar and input parameters (used for plot_field)
96    'set_field_list';...% set the menu of input fields
97    'set_grid';...% creates a grid for PIV
98    'set_grid.fig';...% interface for set_grid
99    'set_object.m';...%  edit a projection object
100    'set_object.fig';...% interface for set_object
101    'set_subdomains';...% sort a set of points defined by scattered coordinates in subdomains, as needed for tps interpolation
102    'stra2num';...% transform letters (a, b, A, B,) or numerical strings ('1','2'..) to the corresponding numbers
103    'sub_field';...% combine the two input fields,
104    'struct2nc';...% %write fields in netcdf files
105    'struct2xml';... transform a matlab structure to a xml tree.
106    'tps_coeff';...% calculate the thin plate spline (tps) coefficients
107    'tps_coeff_field';...% calculate the thin plate spline (tps) coefficients with subdomains for a field structure
108    'tps_eval';... %calculate the thin plate spline (tps) interpolation at a set of points
109    'tps_eval_dxy';...% calculate the derivatives of thin plate spline (tps) interpolation at a set of points (limited to the 2D case)
110    'translate_points';...% associated with GUI translate_points.fig to display translation parameters
111    'translate_points.fig';...
112    'uigetfile_uvmat';... browser, and display of directories, faster than the Matlab fct uigetfile
113    'update_imadoc';...  %update the ImaDoc xml file
114    'update_waitbar';... update the waitbar display, used for ACTION functions in the GUI 'series'
115    'uvmat';...% master function for file scanning and visualisation of 2D fields
116    'uvmat.fig';...  %interface for uvmat
117    'view_field.m';...% function for visualisation of projected fields'
118    'view_field.fig';...%GUI for view_field
119    'xml2struct';...% read an xml file as a Matlab structure, converts numeric character strings into numbers
120    };
121dir_fct=which('uvmat');% path to uvmat
122pathuvmat=fileparts(dir_fct);
123
124%% add the uvmat path to matlab if needed
125if isempty(regexp(path,[pathuvmat '(:|\>)'],'once'))
126    addpath(pathuvmat);
127end
128
129
130%% loop on the list of functions in the uvmat package
131icount=0;
132if ~exist(fullfile(pathuvmat,'@xmltree'),'dir')
133    icount=icount+1;
134    checkmsg{icount}='ERROR installation: toolbox xmltree missing';
135end
136datnum=zeros(1,length(list_fct));
137for i=1:length(list_fct)
138    dir_fct=which(list_fct{i});% path to fct
139    if isempty(dir_fct)
140        icount=icount+1;
141        checkmsg{icount}=[list_fct{i} ' not found'];% test for function not found
142    else
143        pth=fileparts(dir_fct);
144        if ~isequal(pathuvmat,pth) && ~isequal(fullfile(pathuvmat,'private'),pth)
145            icount=icount+1;
146            checkmsg{icount}=[dir_fct ' overrides the package UVMAT'];% bad path for the function
147        end
148        datfile=dir(dir_fct);
149        if isfield(datfile,'datenum')
150            datnum(i)= datfile.datenum;
151        end
152    end
153end
154date_str=datestr(max(datnum));
155
156%% check svn status
157[status,result]=system('svn --help');
158if status==0 % if a svn line command is available
159    svn_info.rep_rev=0;svn_info.cur_rev=0;
160    [tild,result]=system(['svn info ' dir_fct]); %get info fromn the svn server
161    t=regexp(result,'R.vision\s*:\s*(?<rev>\d+)','names');%detect 'revision' or 'Revision' in the text
162    if ~isempty(t)
163        svn_info.cur_rev=str2double(t.rev); %version nbre of the current package
164    end
165    %[tild,result]=system(['svn info -r ''HEAD'' '  pathuvmat]);
166    [tild,result]=system(['svn info ''HEAD'' '  pathuvmat]);
167    t=regexp(result,'R.vision\s*:\s*(?<rev>\d+)','names');
168    if ~isempty(t)
169        svn_info.rep_rev=str2double(t.rev); % version nbre available on the svn repository
170    end
171    [tild,result]=system(['svn status '  pathuvmat]);% '&' prevents the program to stop when the system asks password
172    svn_info.status=result;
173    checkmsg =[checkmsg {['SVN revision : ' num2str(svn_info.cur_rev)]}];%display version nbre of the current uvmat package
174    if svn_info.rep_rev>svn_info.cur_rev %if the repository has a more advanced version than the uvmat package, warning msge
175        checkmsg =[checkmsg ...
176            {['Repository now at revision ' num2str(svn_info.rep_rev) '. Please type svn update in uvmat folder']}];
177    end
178    modifications=regexp(svn_info.status,'M\s[^(\n|\>)]+','match');% detect the files modified compared to the repository
179    if ~isempty(modifications)
180        for ilist=1:numel(modifications)
181            [tild,FileName,FileExt]=fileparts(modifications{ilist});
182            checkmsg=[checkmsg {[FileName FileExt ' modified']}];
183        end
184    end
185else % no svn line command available
186    checkmsg=[checkmsg {'SVN not available'}];
187end
188checkmsg=checkmsg';
189
190%% check dates of compilation
191% currentdir=pwd;
192% cd(pathuvmat)
193% list_compile=dir('*.sh');
194% for ilist=1:numel(list_compile)
195%     mfile=regexprep(list_compile(ilist).name,'.sh$','.m');
196%     if exist(mfile,'file')
197%         datfile=dir(mfile);
198%         if ~isempty(datfile) && isfield(datfile,'datenum') && datfile.datenum>list_compile(ilist).datenum
199%             checkmsg=[checkmsg;{[list_compile(ilist).name ' needs to be updated by compile_functions']}];
200%         end
201%     end
202% end
203% cd(currentdir)
204
Note: See TracBrowser for help on using the repository browser.