## Copyright (C) 2010-2011 John W. Eaton
## Copyright (C) 2010 VZLU Prague
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} unimplemented ()
## Undocumented internal function.
## @end deftypefn

function txt = unimplemented (fcn)

  is_matlab_function = true;

  ## Some smarter cases, add more as needed.
  switch (fcn)

  case "quad2d"
    txt = ["quad2d is not implemented.  Consider using dblquad."];

  case "gsvd"
    txt = ["gsvd is not currently part of Octave.  See the linear-algebra",... 
    "package at @url{http://octave.sf.net/linear-algebra/}."];

  case "linprog"
    txt = ["Octave does not currently provide linprog.  ",...
    "Linear programming problems may be solved using @code{glpk}.  ",...
    "Try @code{help glpk} for more info."];

  case {"ode113", "ode15i", "ode15s", "ode23", "ode23s", "ode23t", "ode45", "odeget", "odeset"}
    txt = ["Octave provides lsode for solving differential equations.  ",...
    "For more information try @code{help lsode}.  ",...
    "Matlab-compatible ODE functions are provided by the odepkg package.  ",...
    "See @url{http://octave.sf.net/odepkg/}."];
  
  otherwise
    if (ismember (fcn, missing_functions ()))
      txt = sprintf ("the `%s' function is not yet implemented in Octave", fcn);
    else
      is_matlab_function = false;
      txt = "";
    endif
  endswitch

  if (is_matlab_function)
    txt = [txt, "\n\n@noindent\nPlease read ",...
           "@url{http://www.octave.org/missing.html} to learn how ",...
           "you can contribute missing functionality."];
    txt = __makeinfo__ (txt);
  endif

  if (nargout == 0)
    warning ("Octave:missing-function", "%s", txt);
  endif

endfunction

function list = missing_functions ()
  persistent list = {
  "DelaunayTri", 
  "MException", 
  "RandStream", 
  "TriRep", 
  "TriScatteredInterp", 
  "addpref", 
  "align", 
  "alim", 
  "alpha", 
  "alphamap", 
  "annotation", 
  "audiodevinfo", 
  "audioplayer", 
  "audiorecorder", 
  "aufinfo", 
  "auread", 
  "auwrite", 
  "avifile", 
  "aviinfo", 
  "aviread", 
  "bar3", 
  "bar3h", 
  "bench", 
  "betaincinv", 
  "bicg", 
  "bicgstabl", 
  "brush", 
  "builddocsearchdb", 
  "bvp4c", 
  "bvp5c", 
  "bvpget", 
  "bvpinit", 
  "bvpset", 
  "bvpxtend", 
  "callSoapService", 
  "calllib", 
  "camdolly", 
  "cameratoolbar", 
  "camlight", 
  "camlookat", 
  "camorbit", 
  "campan", 
  "campos", 
  "camproj", 
  "camroll", 
  "camtarget", 
  "camup", 
  "camva", 
  "camzoom", 
  "cdf2rdf", 
  "cdfepoch", 
  "cdfinfo", 
  "cdfread", 
  "cdfwrite", 
  "cellplot", 
  "checkin", 
  "checkout", 
  "cholinc", 
  "clearvars", 
  "clipboard", 
  "cmopts", 
  "cmpermute", 
  "cmunique", 
  "colordef", 
  "colormapeditor", 
  "commandhistory", 
  "commandwindow", 
  "condeig", 
  "coneplot", 
  "contourslice", 
  "copyobj", 
  "createClassFromWsdl", 
  "createSoapMessage", 
  "customverctrl", 
  "daqread", 
  "datacursormode", 
  "datatipinfo", 
  "dbmex", 
  "dde23", 
  "ddeget", 
  "ddesd", 
  "ddeset", 
  "decic", 
  "depdir", 
  "depfun", 
  "deval", 
  "dialog", 
  "dither", 
  "docopt", 
  "docsearch", 
  "dragrect", 
  "dynamicprops", 
  "echodemo", 
  "ellipj", 
  "ellipke", 
  "erfcinv", 
  "errordlg", 
  "evalc", 
  "exifread", 
  "expint", 
  "export2wsdlg", 
  "figurepalette", 
  "filebrowser", 
  "fill3", 
  "findfigs", 
  "fitsinfo", 
  "fitsread", 
  "flow", 
  "fminsearch", 
  "frame2im", 
  "freqspace", 
  "funm", 
  "gallery", 
  "gammaincinv", 
  "gco", 
  "getframe", 
  "getpixelposition", 
  "getpref", 
  "gmres", 
  "grabcode", 
  "graymon", 
  "gsvd", 
  "guidata", 
  "guide", 
  "guihandles", 
  "handle", 
  "hdf", 
  "hdf5", 
  "hdf5info", 
  "hdf5read", 
  "hdf5write", 
  "hdfinfo", 
  "hdfread", 
  "hdftool", 
  "helpbrowser", 
  "helpdesk", 
  "helpdlg", 
  "helpwin", 
  "hgexport", 
  "hgload", 
  "hgsave", 
  "hgsetget", 
  "hgtransform", 
  "hostid", 
  "ilu", 
  "im2frame", 
  "im2java", 
  "imapprox", 
  "imformats", 
  "import", 
  "importdata", 
  "inmem", 
  "inputParser", 
  "inputdlg", 
  "inspect", 
  "instrfind", 
  "instrfindall", 
  "interpstreamspeed", 
  "iscom", 
  "isinterface", 
  "isjava", 
  "isocaps", 
  "ispref", 
  "isstudent", 
  "javaArray", 
  "javaMethod", 
  "javaMethodEDT", 
  "javaObject", 
  "javaObjectEDT", 
  "javaaddpath", 
  "javachk", 
  "javaclasspath", 
  "javarmpath", 
  "ldl", 
  "libfunctions", 
  "libfunctionsview", 
  "libisloaded", 
  "libpointer", 
  "libstruct", 
  "light", 
  "lightangle", 
  "lighting", 
  "linkaxes", 
  "linkdata", 
  "linsolve", 
  "listdlg", 
  "listfonts", 
  "loadlibrary", 
  "lscov", 
  "lsqr", 
  "makehgtform", 
  "material", 
  "matlabrc", 
  "maxNumCompThreads", 
  "memmapfile", 
  "memory", 
  "metaclass", 
  "methodsview", 
  "minres", 
  "mlint", 
  "mlintrpt", 
  "mmfileinfo", 
  "mmreader", 
  "movegui", 
  "movie", 
  "movie2avi", 
  "msgbox", 
  "multibandread", 
  "multibandwrite", 
  "native2unicode", 
  "noanimate", 
  "ode113", 
  "ode15i", 
  "ode15s", 
  "ode23", 
  "ode23s", 
  "ode23t", 
  "ode23tb", 
  "ode45", 
  "odefile", 
  "odeget", 
  "odeset", 
  "odextend", 
  "open", 
  "openfig", 
  "opengl", 
  "openvar", 
  "ordeig", 
  "ordqz", 
  "ordschur", 
  "padecoef", 
  "pagesetupdlg", 
  "pan", 
  "parseSoapResponse", 
  "path2rc", 
  "pathtool", 
  "pcode", 
  "pdepe", 
  "pdeval", 
  "playshow", 
  "plotbrowser", 
  "plotedit", 
  "plottools", 
  "polyeig", 
  "prefdir", 
  "preferences", 
  "printdlg", 
  "printopt", 
  "printpreview", 
  "profile", 
  "profsave", 
  "propedit", 
  "propertyeditor", 
  "publish", 
  "qmr", 
  "quad2d", 
  "questdlg", 
  "rbbox", 
  "rectangle", 
  "recycle", 
  "reducepatch", 
  "reducevolume", 
  "resample", 
  "reset", 
  "rgbplot", 
  "rmpref", 
  "root", 
  "rotate", 
  "rotate3d", 
  "rsf2csf", 
  "selectmoveresize", 
  "sendmail", 
  "serial", 
  "setpixelposition", 
  "setpref", 
  "showplottool", 
  "shrinkfaces", 
  "smooth3", 
  "snapnow", 
  "sound", 
  "soundsc", 
  "ss2tf", 
  "stream2", 
  "stream3", 
  "streamline", 
  "streamparticles", 
  "streamribbon", 
  "streamslice", 
  "streamtube", 
  "strings", 
  "subvolume", 
  "superclasses", 
  "support", 
  "surf2patch", 
  "symmlq", 
  "syntax", 
  "tetramesh", 
  "texlabel", 
  "textwrap", 
  "tfqmr", 
  "timer", 
  "timerfind", 
  "timerfindall", 
  "timeseries", 
  "toolboxdir", 
  "tscollection", 
  "tstool", 
  "uibuttongroup", 
  "uicontextmenu", 
  "uicontrol",  
  "uigetpref", 
  "uiimport", 
  "uiopen", 
  "uipanel", 
  "uipushtool", 
  "uiresume", 
  "uisave", 
  "uisetcolor", 
  "uisetfont", 
  "uisetpref", 
  "uistack", 
  "uitable", 
  "uitoggletool", 
  "uitoolbar", 
  "uiwait", 
  "undocheckout", 
  "unicode2native", 
  "unloadlibrary", 
  "unmesh", 
  "usejava", 
  "userpath", 
  "validateattributes", 
  "verLessThan", 
  "viewmtx", 
  "visdiff", 
  "volumebounds", 
  "waitbar", 
  "waitfor", 
  "warndlg", 
  "waterfall", 
  "wavfinfo", 
  "wavplay", 
  "wavrecord", 
  "web", 
  "whatsnew", 
  "wk1finfo", 
  "wk1read", 
  "wk1write", 
  "workspace", 
  "xlsfinfo", 
  "xlsread", 
  "xlswrite", 
  "xmlread", 
  "xmlwrite", 
  "xslt", 
  "zoom",
  };
endfunction